Files
2025-10-28 02:05:17 -04:00

600 lines
21 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.27) on Tue Oct 28 02:00:43 EDT 2025 -->
<title>IAvailability</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2025-10-28">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.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="IAvailability";
}
}
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};
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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">noppes.npcs.api.handler.data</a></div>
<h2 title="Interface IAvailability" class="title">Interface IAvailability</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">IAvailability</span></pre>
<div class="block">Defines the conditions that determine if certain NPC interactions
(dialogs, quests, and faction requirements) are available to a player.
<p>
Availability conditions include:
<ul>
<li>Daytime restrictions (Always, Day, or Night)</li>
<li>Dialog conditions (based on whether a dialog has been read or not)</li>
<li>Quest conditions (before, after, active, not active, acceptable, etc.)</li>
<li>Faction requirements (faction ID, availability type and required stance)</li>
<li>Minimum player level</li>
</ul>
The method <a href="#isAvailable(noppes.npcs.api.entity.IPlayer)"><code>isAvailable(IPlayer)</code></a> evaluates all these criteria.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDaytime()">getDaytime</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the daytime condition requirement as an ordinal value.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDialog(int)">getDialog</a></span>&#8203;(int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Retrieves the dialog ID for the specified slot.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMinPlayerLevel()">getMinPlayerLevel</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the minimum player level required for the availability conditions.</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="#getQuest(int)">getQuest</a></span>&#8203;(int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Retrieves the quest ID for the specified slot.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAvailable(noppes.npcs.api.entity.IPlayer)">isAvailable</a></span>&#8203;(<a href="../../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player)</code></th>
<td class="colLast">
<div class="block">Determines whether all availability conditions are met for the given player.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeDialog(int)">removeDialog</a></span>&#8203;(int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Removes the dialog from the specified slot, resetting it to default values.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFaction(int)">removeFaction</a></span>&#8203;(int&nbsp;slot)</code></th>
<td class="colLast">
<div class="block">Removes the faction requirement from the specified slot, resetting it to default values.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeQuest(int)">removeQuest</a></span>&#8203;(int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Removes the quest from the specified slot, resetting it to default values.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDaytime(int)">setDaytime</a></span>&#8203;(int&nbsp;daytime)</code></th>
<td class="colLast">
<div class="block">Sets the daytime condition requirement.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDialog(int,int,int)">setDialog</a></span>&#8203;(int&nbsp;index,
int&nbsp;id,
int&nbsp;type)</code></th>
<td class="colLast">
<div class="block">Sets the dialog for the specified slot with the given dialog ID and availability type.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFaction(int,int,int,int)">setFaction</a></span>&#8203;(int&nbsp;slot,
int&nbsp;id,
int&nbsp;type,
int&nbsp;stance)</code></th>
<td class="colLast">
<div class="block">Sets the faction requirement for the specified slot with the given parameters.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMinPlayerLevel(int)">setMinPlayerLevel</a></span>&#8203;(int&nbsp;level)</code></th>
<td class="colLast">
<div class="block">Sets the minimum player level required for the availability conditions.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQuest(int,int,int)">setQuest</a></span>&#8203;(int&nbsp;index,
int&nbsp;id,
int&nbsp;type)</code></th>
<td class="colLast">
<div class="block">Sets the quest for the specified slot with the given quest ID and availability type.</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="isAvailable(noppes.npcs.api.entity.IPlayer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAvailable</h4>
<pre class="methodSignature">boolean&nbsp;isAvailable&#8203;(<a href="../../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player)</pre>
<div class="block">Determines whether all availability conditions are met for the given player.
<p>
Conditions checked include:
<ul>
<li>Daytime requirement – if set to Day, the player must be in daytime; if Night, in nighttime.</li>
<li>Dialog conditions – all dialog slots (0–3) must match their respective availability settings.</li>
<li>Quest conditions – all quest slots (0–3) must satisfy their availability criteria.</li>
<li>Faction conditions – each faction requirement (slot 0 and 1) must match the specified faction availability and stance.</li>
<li>Minimum player level – the player's level must be at least the required minimum.</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player for whom availability is being checked.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if all conditions are met; false otherwise.</dd>
</dl>
</li>
</ul>
<a id="getDaytime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDaytime</h4>
<pre class="methodSignature">int&nbsp;getDaytime()</pre>
<div class="block">Returns the daytime condition requirement as an ordinal value.
<p>
The returned value corresponds to:
<ul>
<li>0 – Always</li>
<li>1 – Day</li>
<li>2 – Night</li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ordinal value representing the required daytime condition.</dd>
</dl>
</li>
</ul>
<a id="setDaytime(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDaytime</h4>
<pre class="methodSignature">void&nbsp;setDaytime&#8203;(int&nbsp;daytime)</pre>
<div class="block">Sets the daytime condition requirement.
<p>
The provided value is clamped between 0 and 2, corresponding to:
<ul>
<li>0 – Always</li>
<li>1 – Day</li>
<li>2 – Night</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>daytime</code> - the ordinal value for the daytime condition.</dd>
</dl>
</li>
</ul>
<a id="getMinPlayerLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinPlayerLevel</h4>
<pre class="methodSignature">int&nbsp;getMinPlayerLevel()</pre>
<div class="block">Returns the minimum player level required for the availability conditions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the minimum player level.</dd>
</dl>
</li>
</ul>
<a id="setMinPlayerLevel(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMinPlayerLevel</h4>
<pre class="methodSignature">void&nbsp;setMinPlayerLevel&#8203;(int&nbsp;level)</pre>
<div class="block">Sets the minimum player level required for the availability conditions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>level</code> - the minimum player level.</dd>
</dl>
</li>
</ul>
<a id="getDialog(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDialog</h4>
<pre class="methodSignature">int&nbsp;getDialog&#8203;(int&nbsp;index)</pre>
<div class="block">Retrieves the dialog ID for the specified slot.
<p>
Valid slot indices are 0 to 3. A dialog ID of -1 indicates no dialog is set.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the dialog slot index (0–3).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the dialog ID associated with the specified slot.</dd>
</dl>
</li>
</ul>
<a id="setDialog(int,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDialog</h4>
<pre class="methodSignature">void&nbsp;setDialog&#8203;(int&nbsp;index,
int&nbsp;id,
int&nbsp;type)</pre>
<div class="block">Sets the dialog for the specified slot with the given dialog ID and availability type.
<p>
The availability type (provided as an ordinal) determines when the dialog is available:
<ul>
<li>0 – Always</li>
<li>1 – Before (available before the dialog is read)</li>
<li>2 – After (available after the dialog is read)</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the dialog slot index (0–3).</dd>
<dd><code>id</code> - the dialog ID to set.</dd>
<dd><code>type</code> - the availability type as an ordinal value.</dd>
</dl>
</li>
</ul>
<a id="removeDialog(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeDialog</h4>
<pre class="methodSignature">void&nbsp;removeDialog&#8203;(int&nbsp;index)</pre>
<div class="block">Removes the dialog from the specified slot, resetting it to default values.
<p>
After removal, the dialog ID is set to -1 and its availability is reset to Always.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the dialog slot index (0–3).</dd>
</dl>
</li>
</ul>
<a id="getQuest(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQuest</h4>
<pre class="methodSignature">int&nbsp;getQuest&#8203;(int&nbsp;index)</pre>
<div class="block">Retrieves the quest ID for the specified slot.
<p>
Valid slot indices are 0 to 3. A quest ID of -1 indicates no quest is set.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the quest slot index (0–3).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the quest ID for the specified slot.</dd>
</dl>
</li>
</ul>
<a id="setQuest(int,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQuest</h4>
<pre class="methodSignature">void&nbsp;setQuest&#8203;(int&nbsp;index,
int&nbsp;id,
int&nbsp;type)</pre>
<div class="block">Sets the quest for the specified slot with the given quest ID and availability type.
<p>
The availability type for quests is provided as an ordinal and can represent various conditions
such as Always, After, Before, Active, NotActive, Acceptable, or NotAcceptable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the quest slot index (0–3).</dd>
<dd><code>id</code> - the quest ID to set.</dd>
<dd><code>type</code> - the availability type as an ordinal value.</dd>
</dl>
</li>
</ul>
<a id="removeQuest(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeQuest</h4>
<pre class="methodSignature">void&nbsp;removeQuest&#8203;(int&nbsp;index)</pre>
<div class="block">Removes the quest from the specified slot, resetting it to default values.
<p>
After removal, the quest ID is set to -1 and its availability is reset to Always.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the quest slot index (0–3).</dd>
</dl>
</li>
</ul>
<a id="setFaction(int,int,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFaction</h4>
<pre class="methodSignature">void&nbsp;setFaction&#8203;(int&nbsp;slot,
int&nbsp;id,
int&nbsp;type,
int&nbsp;stance)</pre>
<div class="block">Sets the faction requirement for the specified slot with the given parameters.
<p>
The parameters are:
<ul>
<li><code>slot</code> – the faction slot index (0 or 1).</li>
<li><code>id</code> – the faction ID.</li>
<li><code>type</code> – the faction availability type (clamped between 0 and 2).</li>
<li><code>stance</code> – the required faction stance (clamped between 0 and 2).</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>slot</code> - the faction slot index (0 or 1).</dd>
<dd><code>id</code> - the faction ID.</dd>
<dd><code>type</code> - the faction availability type as an ordinal value.</dd>
<dd><code>stance</code> - the required faction stance as an ordinal value.</dd>
</dl>
</li>
</ul>
<a id="removeFaction(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeFaction</h4>
<pre class="methodSignature">void&nbsp;removeFaction&#8203;(int&nbsp;slot)</pre>
<div class="block">Removes the faction requirement from the specified slot, resetting it to default values.
<p>
After removal, the faction ID is set to -1, the availability type is set to Always,
and the faction stance is reset to Friendly.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>slot</code> - the faction slot index (0 or 1).</dd>
</dl>
</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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>