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

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>noppes.npcs.api.handler (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 (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</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="IAbilityHandler.html" title="interface in noppes.npcs.api.handler">IAbilityHandler</a></th>
<td class="colLast">
<div class="block">Handler for ability management.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IActionManager.html" title="interface in noppes.npcs.api.handler">IActionManager</a></th>
<td class="colLast">
<div class="block">Manages a queue of <a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data"><code>IAction</code></a> instances, allowing scheduling of delayed,
 repeating, or conditional "tasks" for NPC scripting.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IAnimationHandler.html" title="interface in noppes.npcs.api.handler">IAnimationHandler</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IAttributeHandler.html" title="interface in noppes.npcs.api.handler">IAttributeHandler</a></th>
<td class="colLast">
<div class="block">Handles registration and lookup of attribute definitions as well as
 retrieval of player attributes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IAuctionHandler.html" title="interface in noppes.npcs.api.handler">IAuctionHandler</a></th>
<td class="colLast">
<div class="block">Handler for the Auction system.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ICloneHandler.html" title="interface in noppes.npcs.api.handler">ICloneHandler</a></th>
<td class="colLast">
<div class="block">Handles storing and spawning cloned entities.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ICustomEffectHandler.html" title="interface in noppes.npcs.api.handler">ICustomEffectHandler</a></th>
<td class="colLast">
<div class="block">Handler interface for managing custom effects.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IDialogHandler.html" title="interface in noppes.npcs.api.handler">IDialogHandler</a></th>
<td class="colLast">
<div class="block">Handles retrieval of dialogs and dialog categories.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IFactionHandler.html" title="interface in noppes.npcs.api.handler">IFactionHandler</a></th>
<td class="colLast">
<div class="block">Handles creation, deletion, and retrieval of factions.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IHookDefinition.html" title="interface in noppes.npcs.api.handler">IHookDefinition</a></th>
<td class="colLast">
<div class="block">Defines metadata for a script hook, enabling rich hook registration with proper
 type information for stub generation, imports, and documentation.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ILinkedItemHandler.html" title="interface in noppes.npcs.api.handler">ILinkedItemHandler</a></th>
<td class="colLast">
<div class="block">Handles registration and retrieval of linked items.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IMagicHandler.html" title="interface in noppes.npcs.api.handler">IMagicHandler</a></th>
<td class="colLast">
<div class="block">Provides methods to access and modify magic and magic cycles.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="INaturalSpawnsHandler.html" title="interface in noppes.npcs.api.handler">INaturalSpawnsHandler</a></th>
<td class="colLast">
<div class="block">Handles natural spawn configurations for custom NPCs.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IOverlayHandler.html" title="interface in noppes.npcs.api.handler">IOverlayHandler</a></th>
<td class="colLast">
<div class="block">Manages skin overlays applied to an entity or player.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IPartyHandler.html" title="interface in noppes.npcs.api.handler">IPartyHandler</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IPlayerBankData.html" title="interface in noppes.npcs.api.handler">IPlayerBankData</a></th>
<td class="colLast">
<div class="block">Holds bank-related data for a player.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IPlayerData.html" title="interface in noppes.npcs.api.handler">IPlayerData</a></th>
<td class="colLast">
<div class="block">Provides access to all persistent data categories for a player,
 including companion, dialog, quest, faction, transport, mail, trade, and ability data.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IPlayerDialogData.html" title="interface in noppes.npcs.api.handler">IPlayerDialogData</a></th>
<td class="colLast">
<div class="block">Tracks which dialogs a player has read.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IPlayerFactionData.html" title="interface in noppes.npcs.api.handler">IPlayerFactionData</a></th>
<td class="colLast">
<div class="block">Tracks a player's faction standing points.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IPlayerItemGiverData.html" title="interface in noppes.npcs.api.handler">IPlayerItemGiverData</a></th>
<td class="colLast">
<div class="block">Tracks item giver interaction data for a player, including
 cooldown timestamps and interaction history.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IPlayerMailData.html" title="interface in noppes.npcs.api.handler">IPlayerMailData</a></th>
<td class="colLast">
<div class="block">Manages a player's mail inbox, including sending, removing, and querying mail.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IPlayerQuestData.html" title="interface in noppes.npcs.api.handler">IPlayerQuestData</a></th>
<td class="colLast">
<div class="block">Tracks a player's quest progress, including active, finished, and tracked quests.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IPlayerTradeData.html" title="interface in noppes.npcs.api.handler">IPlayerTradeData</a></th>
<td class="colLast">
<div class="block">Interface for player trade data (currency and auction claims).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IPlayerTransportData.html" title="interface in noppes.npcs.api.handler">IPlayerTransportData</a></th>
<td class="colLast">
<div class="block">Tracks which transport locations a player has unlocked.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IProfileHandler.html" title="interface in noppes.npcs.api.handler">IProfileHandler</a></th>
<td class="colLast">
<div class="block">Manages player profiles, which allow players to have multiple save slots
 for their CNPC+ data.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IQuestHandler.html" title="interface in noppes.npcs.api.handler">IQuestHandler</a></th>
<td class="colLast">
<div class="block">Handles retrieval of quests and quest categories.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IRecipeHandler.html" title="interface in noppes.npcs.api.handler">IRecipeHandler</a></th>
<td class="colLast">
<div class="block">Handles custom crafting recipes and anvil recipes.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IScriptHookHandler.html" title="interface in noppes.npcs.api.handler">IScriptHookHandler</a></th>
<td class="colLast">
<div class="block">Handler for registering and retrieving script hooks.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ITagHandler.html" title="interface in noppes.npcs.api.handler">ITagHandler</a></th>
<td class="colLast">
<div class="block">Handles creation, deletion, and retrieval of tags.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ITelegraphHandler.html" title="interface in noppes.npcs.api.handler">ITelegraphHandler</a></th>
<td class="colLast">
<div class="block">Handler for creating and managing telegraphs.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ITransportHandler.html" title="interface in noppes.npcs.api.handler">ITransportHandler</a></th>
<td class="colLast">
<div class="block">Handles transport categories and their locations.</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>