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

860 lines
38 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>ICustomEffectHandler</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="ICustomEffectHandler";
}
}
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,"i19":6,"i20":6,"i21":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</a></div>
<h2 title="Interface ICustomEffectHandler" class="title">Interface ICustomEffectHandler</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">ICustomEffectHandler</span></pre>
<div class="block">Handler interface for managing custom effects.
Provides methods to create, retrieve, apply, remove, and save custom effects.</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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyEffect(noppes.npcs.api.entity.IPlayer,int,int,byte)">applyEffect</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id,
int&nbsp;duration,
byte&nbsp;level)</code></th>
<td class="colLast">
<div class="block">Applies the effect with the specified ID to the player.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyEffect(noppes.npcs.api.entity.IPlayer,int,int,byte,int)">applyEffect</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id,
int&nbsp;duration,
byte&nbsp;level,
int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Applies the effect with the specified ID and index to the player.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyEffect(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect,int,byte)">applyEffect</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect,
int&nbsp;duration,
byte&nbsp;level)</code></th>
<td class="colLast">
<div class="block">Applies the specified custom effect to the player.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyEffect(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect,int,byte,int)">applyEffect</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect,
int&nbsp;duration,
byte&nbsp;level,
int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Applies the specified custom effect (with the given index) to the player.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearEffects(noppes.npcs.api.entity.IPlayer)">clearEffects</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">Clears all custom effects from the specified 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="#clearEffects(noppes.npcs.api.entity.IPlayer,int)">clearEffects</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Clears all custom effects with the specified index from the player.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createEffect(java.lang.String)">createEffect</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Creates a new custom effect with the specified name.</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="#deleteEffect(java.lang.String)">deleteEffect</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Deletes the custom effect with the specified name.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEffect(int,int)">getEffect</a></span>&#8203;(int&nbsp;id,
int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Retrieves the custom effect with the specified ID and index.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEffect(java.lang.String)">getEffect</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Retrieves the custom effect with the specified name.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEffect(java.lang.String,int)">getEffect</a></span>&#8203;(java.lang.String&nbsp;name,
int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Retrieves the custom effect with the specified name and index.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEffectDuration(noppes.npcs.api.entity.IPlayer,int)">getEffectDuration</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Retrieves the remaining duration of the effect with the specified ID for the given player.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEffectDuration(noppes.npcs.api.entity.IPlayer,int,int)">getEffectDuration</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id,
int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Retrieves the remaining duration of the effect with the specified ID and index for the given player.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEffectDuration(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect)">getEffectDuration</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect)</code></th>
<td class="colLast">
<div class="block">Retrieves the remaining duration of the given custom effect for the specified player.</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="#getEffectDuration(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect,int)">getEffectDuration</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect,
int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Retrieves the remaining duration of the specified custom effect (with the given index) for the player.</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="#hasEffect(noppes.npcs.api.entity.IPlayer,int)">hasEffect</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Checks if the specified player currently has an effect with the given ID.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasEffect(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect)">hasEffect</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect)</code></th>
<td class="colLast">
<div class="block">Checks if the specified player currently has the given custom effect.</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="#removeEffect(noppes.npcs.api.entity.IPlayer,int)">removeEffect</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Removes the effect with the specified ID from the player.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeEffect(noppes.npcs.api.entity.IPlayer,int,int)">removeEffect</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id,
int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Removes the effect with the specified ID and index from the player.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeEffect(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect)">removeEffect</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect)</code></th>
<td class="colLast">
<div class="block">Removes the specified custom effect from the player.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeEffect(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect,int)">removeEffect</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect,
int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Removes the specified custom effect (with the given index) from the player.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#saveEffect(noppes.npcs.api.handler.data.ICustomEffect)">saveEffect</a></span>&#8203;(<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;customEffect)</code></th>
<td class="colLast">
<div class="block">Persists the given custom effect.</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="createEffect(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createEffect</h4>
<pre class="methodSignature"><a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;createEffect&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block">Creates a new custom effect with the specified name.
If an effect with the given name already exists, the existing effect is returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the custom effect to create</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the newly created or existing custom effect</dd>
</dl>
</li>
</ul>
<a id="getEffect(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEffect</h4>
<pre class="methodSignature"><a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;getEffect&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block">Retrieves the custom effect with the specified name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the custom effect to retrieve</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the custom effect with the given name, or null if not found</dd>
</dl>
</li>
</ul>
<a id="deleteEffect(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteEffect</h4>
<pre class="methodSignature">void&nbsp;deleteEffect&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block">Deletes the custom effect with the specified name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the custom effect to delete</dd>
</dl>
</li>
</ul>
<a id="hasEffect(noppes.npcs.api.entity.IPlayer,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasEffect</h4>
<pre class="methodSignature">boolean&nbsp;hasEffect&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id)</pre>
<div class="block">Checks if the specified player currently has an effect with the given ID.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player to check</dd>
<dd><code>id</code> - the ID of the status effect</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the player has the effect, false otherwise</dd>
</dl>
</li>
</ul>
<a id="hasEffect(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasEffect</h4>
<pre class="methodSignature">boolean&nbsp;hasEffect&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect)</pre>
<div class="block">Checks if the specified player currently has the given custom effect.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player to check</dd>
<dd><code>effect</code> - the custom effect to check for</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the player has the effect, false otherwise</dd>
</dl>
</li>
</ul>
<a id="getEffectDuration(noppes.npcs.api.entity.IPlayer,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEffectDuration</h4>
<pre class="methodSignature">int&nbsp;getEffectDuration&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id)</pre>
<div class="block">Retrieves the remaining duration of the effect with the specified ID for the given player.
<p>
Return values:
<ul>
<li>-1 if the player does not have the effect</li>
<li>-100 if the effect has an infinite duration</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player whose effect duration is queried</dd>
<dd><code>id</code> - the ID of the status effect</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the remaining effect time in seconds</dd>
</dl>
</li>
</ul>
<a id="getEffectDuration(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEffectDuration</h4>
<pre class="methodSignature">int&nbsp;getEffectDuration&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect)</pre>
<div class="block">Retrieves the remaining duration of the given custom effect for the specified player.
<p>
Return values:
<ul>
<li>-1 if the player does not have the effect</li>
<li>-100 if the effect has an infinite duration</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player whose effect duration is queried</dd>
<dd><code>effect</code> - the custom effect to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the remaining effect time in seconds</dd>
</dl>
</li>
</ul>
<a id="applyEffect(noppes.npcs.api.entity.IPlayer,int,int,byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyEffect</h4>
<pre class="methodSignature">void&nbsp;applyEffect&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id,
int&nbsp;duration,
byte&nbsp;level)</pre>
<div class="block">Applies the effect with the specified ID to the player.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player to apply the effect to</dd>
<dd><code>id</code> - the ID of the status effect</dd>
<dd><code>duration</code> - the duration of the effect in seconds (-100 for infinite duration)</dd>
<dd><code>level</code> - the level of the effect (some effects may ignore this value)</dd>
</dl>
</li>
</ul>
<a id="applyEffect(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect,int,byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyEffect</h4>
<pre class="methodSignature">void&nbsp;applyEffect&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect,
int&nbsp;duration,
byte&nbsp;level)</pre>
<div class="block">Applies the specified custom effect to the player.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player to apply the effect to</dd>
<dd><code>effect</code> - the custom effect to apply</dd>
<dd><code>duration</code> - the duration of the effect in seconds (-100 for infinite duration)</dd>
<dd><code>level</code> - the level of the effect (some effects may ignore this value)</dd>
</dl>
</li>
</ul>
<a id="removeEffect(noppes.npcs.api.entity.IPlayer,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeEffect</h4>
<pre class="methodSignature">void&nbsp;removeEffect&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id)</pre>
<div class="block">Removes the effect with the specified ID from the player.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player to remove the effect from</dd>
<dd><code>id</code> - the ID of the status effect to remove</dd>
</dl>
</li>
</ul>
<a id="removeEffect(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeEffect</h4>
<pre class="methodSignature">void&nbsp;removeEffect&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect)</pre>
<div class="block">Removes the specified custom effect from the player.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player to remove the effect from</dd>
<dd><code>effect</code> - the custom effect to remove</dd>
</dl>
</li>
</ul>
<a id="clearEffects(noppes.npcs.api.entity.IPlayer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearEffects</h4>
<pre class="methodSignature">void&nbsp;clearEffects&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player)</pre>
<div class="block">Clears all custom effects from the specified player.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player whose effects should be cleared</dd>
</dl>
</li>
</ul>
<a id="applyEffect(noppes.npcs.api.entity.IPlayer,int,int,byte,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyEffect</h4>
<pre class="methodSignature">void&nbsp;applyEffect&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id,
int&nbsp;duration,
byte&nbsp;level,
int&nbsp;index)</pre>
<div class="block">Applies the effect with the specified ID and index to the player.
The index parameter allows for multiple variants of the same effect.
<p>
Note: INDEX: 0: CNPC+, 1: DBC Addon</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player to apply the effect to</dd>
<dd><code>id</code> - the ID of the status effect</dd>
<dd><code>duration</code> - the duration of the effect in seconds (-100 for infinite duration)</dd>
<dd><code>level</code> - the level of the effect</dd>
<dd><code>index</code> - the index to differentiate between variants of the effect (INDEX: 0: CNPC+, 1: DBC Addon)</dd>
</dl>
</li>
</ul>
<a id="applyEffect(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect,int,byte,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyEffect</h4>
<pre class="methodSignature">void&nbsp;applyEffect&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect,
int&nbsp;duration,
byte&nbsp;level,
int&nbsp;index)</pre>
<div class="block">Applies the specified custom effect (with the given index) to the player.
<p>
Note: INDEX: 0: CNPC+, 1: DBC Addon</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player to apply the effect to</dd>
<dd><code>effect</code> - the custom effect to apply</dd>
<dd><code>duration</code> - the duration of the effect in seconds (-100 for infinite duration)</dd>
<dd><code>level</code> - the level of the effect</dd>
<dd><code>index</code> - the index to differentiate between variants of the effect (INDEX: 0: CNPC+, 1: DBC Addon)</dd>
</dl>
</li>
</ul>
<a id="removeEffect(noppes.npcs.api.entity.IPlayer,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeEffect</h4>
<pre class="methodSignature">void&nbsp;removeEffect&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id,
int&nbsp;index)</pre>
<div class="block">Removes the effect with the specified ID and index from the player.
<p>
Note: INDEX: 0: CNPC+, 1: DBC Addon</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player to remove the effect from</dd>
<dd><code>id</code> - the ID of the status effect to remove</dd>
<dd><code>index</code> - the index of the effect variant to remove (INDEX: 0: CNPC+, 1: DBC Addon)</dd>
</dl>
</li>
</ul>
<a id="removeEffect(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeEffect</h4>
<pre class="methodSignature">void&nbsp;removeEffect&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect,
int&nbsp;index)</pre>
<div class="block">Removes the specified custom effect (with the given index) from the player.
<p>
Note: INDEX: 0: CNPC+, 1: DBC Addon</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player to remove the effect from</dd>
<dd><code>effect</code> - the custom effect to remove</dd>
<dd><code>index</code> - the index of the effect variant to remove (INDEX: 0: CNPC+, 1: DBC Addon)</dd>
</dl>
</li>
</ul>
<a id="clearEffects(noppes.npcs.api.entity.IPlayer,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearEffects</h4>
<pre class="methodSignature">void&nbsp;clearEffects&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;index)</pre>
<div class="block">Clears all custom effects with the specified index from the player.
<p>
Note: INDEX: 0: CNPC+, 1: DBC Addon</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player whose effects should be cleared</dd>
<dd><code>index</code> - the index of the effect variants to clear (INDEX: 0: CNPC+, 1: DBC Addon)</dd>
</dl>
</li>
</ul>
<a id="getEffectDuration(noppes.npcs.api.entity.IPlayer,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEffectDuration</h4>
<pre class="methodSignature">int&nbsp;getEffectDuration&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
int&nbsp;id,
int&nbsp;index)</pre>
<div class="block">Retrieves the remaining duration of the effect with the specified ID and index for the given player.
<p>
Return values:
<ul>
<li>-1 if the player does not have the effect</li>
<li>-100 if the effect has an infinite duration</li>
</ul>
<p>
Note: INDEX: 0: CNPC+, 1: DBC Addon</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player whose effect duration is queried</dd>
<dd><code>id</code> - the ID of the status effect</dd>
<dd><code>index</code> - the index of the effect variant (INDEX: 0: CNPC+, 1: DBC Addon)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the remaining effect time in seconds</dd>
</dl>
</li>
</ul>
<a id="getEffectDuration(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.handler.data.ICustomEffect,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEffectDuration</h4>
<pre class="methodSignature">int&nbsp;getEffectDuration&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player,
<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;effect,
int&nbsp;index)</pre>
<div class="block">Retrieves the remaining duration of the specified custom effect (with the given index) for the player.
<p>
Return values:
<ul>
<li>-1 if the player does not have the effect</li>
<li>-100 if the effect has an infinite duration</li>
</ul>
<p>
Note: INDEX: 0: CNPC+, 1: DBC Addon</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - the player whose effect duration is queried</dd>
<dd><code>effect</code> - the custom effect to check</dd>
<dd><code>index</code> - the index of the effect variant (INDEX: 0: CNPC+, 1: DBC Addon)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the remaining effect time in seconds</dd>
</dl>
</li>
</ul>
<a id="getEffect(java.lang.String,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEffect</h4>
<pre class="methodSignature"><a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;getEffect&#8203;(java.lang.String&nbsp;name,
int&nbsp;index)</pre>
<div class="block">Retrieves the custom effect with the specified name and index.
<p>
Note: INDEX: 0: CNPC+, 1: DBC Addon</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the custom effect</dd>
<dd><code>index</code> - the index of the effect variant (INDEX: 0: CNPC+, 1: DBC Addon)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the custom effect matching the name and index, or null if not found</dd>
</dl>
</li>
</ul>
<a id="getEffect(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEffect</h4>
<pre class="methodSignature"><a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;getEffect&#8203;(int&nbsp;id,
int&nbsp;index)</pre>
<div class="block">Retrieves the custom effect with the specified ID and index.
<p>
Note: INDEX: 0: CNPC+, 1: DBC Addon</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the ID of the custom effect</dd>
<dd><code>index</code> - the index of the effect variant (INDEX: 0: CNPC+, 1: DBC Addon)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the custom effect matching the ID and index, or null if not found</dd>
</dl>
</li>
</ul>
<a id="saveEffect(noppes.npcs.api.handler.data.ICustomEffect)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>saveEffect</h4>
<pre class="methodSignature"><a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;saveEffect&#8203;(<a href="data/ICustomEffect.html" title="interface in noppes.npcs.api.handler.data">ICustomEffect</a>&nbsp;customEffect)</pre>
<div class="block">Persists the given custom effect.
This method saves the effect and returns the saved instance, potentially with an updated ID or name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>customEffect</code> - the custom effect to save</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the saved custom effect instance</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>