CustomNPC-Plus/experimental/dev/noppes/npcs/api/handler/data/package-summary.html

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>noppes.npcs.api.handler.data (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="noppes.npcs.api.handler.data (CustomNPC-Plus 1.11.1 API)";
        }
    }
    catch(err) {
    }
//-->
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 class="navBarCell1Rev">Package</li>
<li>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&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>
<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>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;noppes.npcs.api.handler.data</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a></th>
<td class="colLast">
<div class="block">Represents a single "task" that can be executed over multiple ticks,
 supports delayed start, limited duration, repeating intervals, data storage,
 and chaining to neighboring tasks.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IActionChain.html" title="interface in noppes.npcs.api.handler.data">IActionChain</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IActionListener.html" title="interface in noppes.npcs.api.handler.data">IActionListener</a></th>
<td class="colLast">
<div class="block">Listener interface for action hooks.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IActionQueue.html" title="interface in noppes.npcs.api.handler.data">IActionQueue</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IAnimation.html" title="interface in noppes.npcs.api.handler.data">IAnimation</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IAnimationData.html" title="interface in noppes.npcs.api.handler.data">IAnimationData</a></th>
<td class="colLast">
<div class="block">Holds and manages animation data for an animatable entity.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IAnvilRecipe.html" title="interface in noppes.npcs.api.handler.data">IAnvilRecipe</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IAttributeDefinition.html" title="interface in noppes.npcs.api.handler.data">IAttributeDefinition</a></th>
<td class="colLast">
<div class="block">Defines the blueprint for an attribute.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IAuctionClaim.html" title="interface in noppes.npcs.api.handler.data">IAuctionClaim</a></th>
<td class="colLast">
<div class="block">Represents an auction claim (item or currency to be collected).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IAuctionListing.html" title="interface in noppes.npcs.api.handler.data">IAuctionListing</a></th>
<td class="colLast">
<div class="block">Represents an auction listing.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IAvailability.html" title="interface in noppes.npcs.api.handler.data">IAvailability</a></th>
<td class="colLast">
<div class="block">Defines the conditions that determine if certain NPC interactions
 (dialogs, quests, and faction requirements) are available to a player.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ICustomAttribute.html" title="interface in noppes.npcs.api.handler.data">ICustomAttribute</a></th>
<td class="colLast">
<div class="block">Represents an instance of a custom attribute.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IDialog.html" title="interface in noppes.npcs.api.handler.data">IDialog</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IDialogCategory.html" title="interface in noppes.npcs.api.handler.data">IDialogCategory</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IDialogImage.html" title="interface in noppes.npcs.api.handler.data">IDialogImage</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IDialogOption.html" title="interface in noppes.npcs.api.handler.data">IDialogOption</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IFaction.html" title="interface in noppes.npcs.api.handler.data">IFaction</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IFrame.html" title="interface in noppes.npcs.api.handler.data">IFrame</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IFramePart.html" title="interface in noppes.npcs.api.handler.data">IFramePart</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ILine.html" title="interface in noppes.npcs.api.handler.data">ILine</a></th>
<td class="colLast">
<div class="block">Represents a single NPC dialog line with text, an optional sound, and target formatting.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ILines.html" title="interface in noppes.npcs.api.handler.data">ILines</a></th>
<td class="colLast">
<div class="block">A collection of dialog lines, supporting creation, indexed access, and random retrieval.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ILinkedItem.html" title="interface in noppes.npcs.api.handler.data">ILinkedItem</a></th>
<td class="colLast">
<div class="block">Represents a linked item definition.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IMagic.html" title="interface in noppes.npcs.api.handler.data">IMagic</a></th>
<td class="colLast">
<div class="block">Represents a magic element that can have interactions with other magics.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IMagicCycle.html" title="interface in noppes.npcs.api.handler.data">IMagicCycle</a></th>
<td class="colLast">
<div class="block">Represents a cycle (or category) grouping for magics.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IMagicData.html" title="interface in noppes.npcs.api.handler.data">IMagicData</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="INaturalSpawn.html" title="interface in noppes.npcs.api.handler.data">INaturalSpawn</a></th>
<td class="colLast">
<div class="block">Configures a natural spawn entry for custom NPCs, including entity templates,
 biome restrictions, spawn conditions, and cooldowns.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IParty.html" title="interface in noppes.npcs.api.handler.data">IParty</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IPartyOptions.html" title="interface in noppes.npcs.api.handler.data">IPartyOptions</a></th>
<td class="colLast">
<div class="block">Configures party-related options for quests, controlling membership requirements,
 reward distribution, completion rules, and party size limits.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IPlayerAttributes.html" title="interface in noppes.npcs.api.handler.data">IPlayerAttributes</a></th>
<td class="colLast">
<div class="block">Represents a collection of a player's custom attributes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IPlayerEffect.html" title="interface in noppes.npcs.api.handler.data">IPlayerEffect</a></th>
<td class="colLast">
<div class="block">Represents an active custom effect instance on a player.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IPlayerMail.html" title="interface in noppes.npcs.api.handler.data">IPlayerMail</a></th>
<td class="colLast">
<div class="block">Represents a mail message sent to a player, containing pages of text,
 sender info, optional quest, and item attachments.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IProfile.html" title="interface in noppes.npcs.api.handler.data">IProfile</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IProfileOptions.html" title="interface in noppes.npcs.api.handler.data">IProfileOptions</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IQuest.html" title="interface in noppes.npcs.api.handler.data">IQuest</a></th>
<td class="colLast">
<div class="block">Represents a quest with objectives, rewards, repeatability, and party/profile options.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IQuestCategory.html" title="interface in noppes.npcs.api.handler.data">IQuestCategory</a></th>
<td class="colLast">
<div class="block">Represents a category that groups related quests together.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IQuestDialog.html" title="interface in noppes.npcs.api.handler.data">IQuestDialog</a></th>
<td class="colLast">
<div class="block">Quest objective interface for dialog-type quests.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IQuestInterface.html" title="interface in noppes.npcs.api.handler.data">IQuestInterface</a></th>
<td class="colLast">
<div class="block">Marker interface for quest objective types (e.g., kill, item, location, dialog).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IQuestItem.html" title="interface in noppes.npcs.api.handler.data">IQuestItem</a></th>
<td class="colLast">
<div class="block">Quest objective interface for item-collection quests.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IQuestKill.html" title="interface in noppes.npcs.api.handler.data">IQuestKill</a></th>
<td class="colLast">
<div class="block">Quest objective interface for kill-type quests.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IQuestLocation.html" title="interface in noppes.npcs.api.handler.data">IQuestLocation</a></th>
<td class="colLast">
<div class="block">Quest objective interface for location-based quests.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IQuestObjective.html" title="interface in noppes.npcs.api.handler.data">IQuestObjective</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IRecipe.html" title="interface in noppes.npcs.api.handler.data">IRecipe</a></th>
<td class="colLast">
<div class="block">Represents a custom crafting recipe for the carpentry table or vanilla workbench.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ISlot.html" title="interface in noppes.npcs.api.handler.data">ISlot</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ISound.html" title="interface in noppes.npcs.api.handler.data">ISound</a></th>
<td class="colLast">
<div class="block">Represents a sound that can be played at a position or attached to an entity,
 with configurable volume, pitch, repeat behavior, and position.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ITag.html" title="interface in noppes.npcs.api.handler.data">ITag</a></th>
<td class="colLast">
<div class="block">Represents a tag that can be applied to NPCs for categorization and filtering.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ITransportCategory.html" title="interface in noppes.npcs.api.handler.data">ITransportCategory</a></th>
<td class="colLast">
<div class="block">Represents a category that groups transport locations together.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ITransportLocation.html" title="interface in noppes.npcs.api.handler.data">ITransportLocation</a></th>
<td class="colLast">
<div class="block">Represents a transport destination that players can teleport to.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>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&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>
<a id="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>