Files
CustomNPC-Plus/experimental/dev/noppes/npcs/api/ability/IPlayerAbilityData.html
T
2026-03-11 20:06:44 +00:00

737 lines
30 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>IPlayerAbilityData (CustomNPC-Plus 1.11 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="IPlayerAbilityData (CustomNPC-Plus 1.11 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><div id="javadoc-header"> <a href="/CustomNPC-Plus/" class="header-brand"> <div class="header-title"> CustomNPC+ <span>Javadoc Reference</span> </div> </a> <a href="/CustomNPC-Plus/" class="header-back"> Back to Index </a> </div></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&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.ability</a></div>
<h2 title="Interface IPlayerAbilityData" class="title">Interface IPlayerAbilityData</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">IPlayerAbilityData</span></pre>
<div class="block">Interface for managing player abilities.
Players reference abilities by key (built-in names or custom UUIDs).
<p>
Access via IPlayerData.getAbilityData()</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>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#activateAbility()">activateAbility</a></span>()</code></th>
<td class="colLast">
<div class="block">Activate the currently selected ability.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#activateAbility(java.lang.String)">activateAbility</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Activate a specific ability by key.</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="#completeCurrentAbility()">completeCurrentAbility</a></span>()</code></th>
<td class="colLast">
<div class="block">Signal the current ability to complete immediately.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="IAbility.html" title="interface in noppes.npcs.api.ability">IAbility</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentAbility()">getCurrentAbility</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the currently executing ability.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSelectedAbilityKey()">getSelectedAbilityKey</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the key of the currently selected ability.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSelectedIndex()">getSelectedIndex</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the currently selected ability index.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getToggleState(java.lang.String)">getToggleState</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Get the current toggle state for an ability.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUnlockedAbilities()">getUnlockedAbilities</a></span>()</code></th>
<td class="colLast">
<div class="block">Get all unlocked ability keys.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasUnlockedAbility(java.lang.String)">hasUnlockedAbility</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Check if the player has unlocked a specific ability.</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="#interruptCurrentAbility()">interruptCurrentAbility</a></span>()</code></th>
<td class="colLast">
<div class="block">Interrupt the currently executing ability.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAbilityToggled(java.lang.String)">isAbilityToggled</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Check if a toggle ability is currently active (any state &gt; 0).</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isExecutingAbility()">isExecutingAbility</a></span>()</code></th>
<td class="colLast">
<div class="block">Check if the player is currently executing an ability.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOnCooldown()">isOnCooldown</a></span>()</code></th>
<td class="colLast">
<div class="block">Check if the player is on universal cooldown.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOnCooldown(java.lang.String)">isOnCooldown</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Check if a specific ability is on cooldown.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lockAbility(java.lang.String)">lockAbility</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Lock (remove) an ability from this player.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetAllCooldowns()">resetAllCooldowns</a></span>()</code></th>
<td class="colLast">
<div class="block">Reset all cooldowns.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetCooldown()">resetCooldown</a></span>()</code></th>
<td class="colLast">
<div class="block">Reset the universal cooldown.</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="#resetCooldown(java.lang.String)">resetCooldown</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Reset cooldown for a specific ability key.</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="#selectNext()">selectNext</a></span>()</code></th>
<td class="colLast">
<div class="block">Select the next ability in the list.</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="#selectPrevious()">selectPrevious</a></span>()</code></th>
<td class="colLast">
<div class="block">Select the previous ability in the list.</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="#setSelectedIndex(int)">setSelectedIndex</a></span>&#8203;(int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Set the selected ability index.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setToggleState(java.lang.String,int)">setToggleState</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key,
int&nbsp;state)</code></th>
<td class="colLast">
<div class="block">Set a toggle to a specific state.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toggleAbility(java.lang.String)">toggleAbility</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Cycle a toggle ability to its next state.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unlockAbility(java.lang.String)">unlockAbility</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Unlock an ability for this player.</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="getUnlockedAbilities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnlockedAbilities</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]&nbsp;getUnlockedAbilities()</pre>
<div class="block">Get all unlocked ability keys.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>array of ability keys</dd>
</dl>
</li>
</ul>
<a id="unlockAbility(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unlockAbility</h4>
<pre class="methodSignature">void&nbsp;unlockAbility&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</pre>
<div class="block">Unlock an ability for this player.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The ability key (built-in name or custom UUID)</dd>
</dl>
</li>
</ul>
<a id="lockAbility(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lockAbility</h4>
<pre class="methodSignature">void&nbsp;lockAbility&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</pre>
<div class="block">Lock (remove) an ability from this player.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the ability key</dd>
</dl>
</li>
</ul>
<a id="hasUnlockedAbility(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasUnlockedAbility</h4>
<pre class="methodSignature">boolean&nbsp;hasUnlockedAbility&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</pre>
<div class="block">Check if the player has unlocked a specific ability.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the ability key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if unlocked</dd>
</dl>
</li>
</ul>
<a id="getSelectedIndex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectedIndex</h4>
<pre class="methodSignature">int&nbsp;getSelectedIndex()</pre>
<div class="block">Get the currently selected ability index.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the selected index</dd>
</dl>
</li>
</ul>
<a id="setSelectedIndex(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSelectedIndex</h4>
<pre class="methodSignature">void&nbsp;setSelectedIndex&#8203;(int&nbsp;index)</pre>
<div class="block">Set the selected ability index.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the ability index</dd>
</dl>
</li>
</ul>
<a id="getSelectedAbilityKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectedAbilityKey</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getSelectedAbilityKey()</pre>
<div class="block">Get the key of the currently selected ability.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the selected ability key</dd>
</dl>
</li>
</ul>
<a id="selectNext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectNext</h4>
<pre class="methodSignature">void&nbsp;selectNext()</pre>
<div class="block">Select the next ability in the list.</div>
</li>
</ul>
<a id="selectPrevious()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectPrevious</h4>
<pre class="methodSignature">void&nbsp;selectPrevious()</pre>
<div class="block">Select the previous ability in the list.</div>
</li>
</ul>
<a id="isExecutingAbility()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExecutingAbility</h4>
<pre class="methodSignature">boolean&nbsp;isExecutingAbility()</pre>
<div class="block">Check if the player is currently executing an ability.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if executing</dd>
</dl>
</li>
</ul>
<a id="getCurrentAbility()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentAbility</h4>
<pre class="methodSignature"><a href="IAbility.html" title="interface in noppes.npcs.api.ability">IAbility</a>&nbsp;getCurrentAbility()</pre>
<div class="block">Get the currently executing ability.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current ability, or null</dd>
</dl>
</li>
</ul>
<a id="interruptCurrentAbility()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interruptCurrentAbility</h4>
<pre class="methodSignature">void&nbsp;interruptCurrentAbility()</pre>
<div class="block">Interrupt the currently executing ability.</div>
</li>
</ul>
<a id="completeCurrentAbility()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>completeCurrentAbility</h4>
<pre class="methodSignature">void&nbsp;completeCurrentAbility()</pre>
<div class="block">Signal the current ability to complete immediately.</div>
</li>
</ul>
<a id="isOnCooldown()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOnCooldown</h4>
<pre class="methodSignature">boolean&nbsp;isOnCooldown()</pre>
<div class="block">Check if the player is on universal cooldown.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if on cooldown</dd>
</dl>
</li>
</ul>
<a id="isOnCooldown(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOnCooldown</h4>
<pre class="methodSignature">boolean&nbsp;isOnCooldown&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</pre>
<div class="block">Check if a specific ability is on cooldown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The ability key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if on cooldown</dd>
</dl>
</li>
</ul>
<a id="resetCooldown()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetCooldown</h4>
<pre class="methodSignature">void&nbsp;resetCooldown()</pre>
<div class="block">Reset the universal cooldown.</div>
</li>
</ul>
<a id="resetCooldown(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetCooldown</h4>
<pre class="methodSignature">void&nbsp;resetCooldown&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</pre>
<div class="block">Reset cooldown for a specific ability key.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The ability key</dd>
</dl>
</li>
</ul>
<a id="resetAllCooldowns()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetAllCooldowns</h4>
<pre class="methodSignature">void&nbsp;resetAllCooldowns()</pre>
<div class="block">Reset all cooldowns.</div>
</li>
</ul>
<a id="activateAbility()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>activateAbility</h4>
<pre class="methodSignature">boolean&nbsp;activateAbility()</pre>
<div class="block">Activate the currently selected ability.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if activated</dd>
</dl>
</li>
</ul>
<a id="activateAbility(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>activateAbility</h4>
<pre class="methodSignature">boolean&nbsp;activateAbility&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</pre>
<div class="block">Activate a specific ability by key.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the ability key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if activated</dd>
</dl>
</li>
</ul>
<a id="toggleAbility(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toggleAbility</h4>
<pre class="methodSignature">int&nbsp;toggleAbility&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</pre>
<div class="block">Cycle a toggle ability to its next state.
Off -&gt; State 1 -&gt; State 2 -&gt; ... -&gt; State N -&gt; Off</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the ability key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The new state (0 = off, 1+ = active state number)</dd>
</dl>
</li>
</ul>
<a id="getToggleState(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getToggleState</h4>
<pre class="methodSignature">int&nbsp;getToggleState&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</pre>
<div class="block">Get the current toggle state for an ability.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the ability key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>0 if not active, 1+ for active state</dd>
</dl>
</li>
</ul>
<a id="setToggleState(java.lang.String,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setToggleState</h4>
<pre class="methodSignature">void&nbsp;setToggleState&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key,
int&nbsp;state)</pre>
<div class="block">Set a toggle to a specific state. 0 = deactivate, 1+ = specific state.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the ability key</dd>
<dd><code>state</code> - the toggle state</dd>
</dl>
</li>
</ul>
<a id="isAbilityToggled(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isAbilityToggled</h4>
<pre class="methodSignature">boolean&nbsp;isAbilityToggled&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</pre>
<div class="block">Check if a toggle ability is currently active (any state &gt; 0).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the ability key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if toggled on</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-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>
<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>