<li><ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/PlayerBackpack.html"title="class in io.github.thebusybiscuit.slimefun4.api.player"><spanclass="typeNameLink">Prev Class</span></a></li>
<dd><ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Keyed.html?is-external=true"title="class or interface in org.bukkit">Keyed</a></dd>
</dl>
<hr>
<br>
<pre>public class <spanclass="typeNameLabel">StatusEffect</span>
extends java.lang.Object
implements <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Keyed.html?is-external=true"title="class or interface in org.bukkit">Keyed</a></pre>
<divclass="block">A very simple API that is meant for adding/getting/clearing custom status effects
to/from players.
The effects are stored via <code>PersistentDataAPI</code> and use NBT data that is
saved across server restarts.
You can specify a level for your status effect too.</div>
<thclass="colOne"scope="col">Constructor and Description</th>
</tr>
<trclass="altColor">
<tdclass="colOne"><code><spanclass="memberNameLink"><ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html#StatusEffect-org.bukkit.NamespacedKey-">StatusEffect</a></span>(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/NamespacedKey.html?is-external=true"title="class or interface in org.bukkit">NamespacedKey</a> key)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ulclass="blockList">
<liclass="blockList"><aname="method.summary">
<!---->
</a>
<h3>Method Summary</h3>
<tableclass="memberSummary"border="0"cellpadding="3"cellspacing="0"summary="Method Summary table, listing methods, and an explanation">
<thclass="colFirst"scope="col">Modifier and Type</th>
<thclass="colLast"scope="col">Method and Description</th>
</tr>
<trid="i0"class="altColor">
<tdclass="colFirst"><code>void</code></td>
<tdclass="colLast"><code><spanclass="memberNameLink"><ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html#add-org.bukkit.entity.Player-int-int-java.util.concurrent.TimeUnit-">add</a></span>(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity">Player</a> p,
int level,
int duration,
java.util.concurrent.TimeUnit unit)</code>
<divclass="block">This applies this <ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html"title="class in io.github.thebusybiscuit.slimefun4.api.player"><code>StatusEffect</code></a> to the given <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a>.</div>
</td>
</tr>
<trid="i1"class="rowColor">
<tdclass="colFirst"><code>void</code></td>
<tdclass="colLast"><code><spanclass="memberNameLink"><ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html#add-org.bukkit.entity.Player-int-java.util.concurrent.TimeUnit-">add</a></span>(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity">Player</a> p,
int duration,
java.util.concurrent.TimeUnit unit)</code>
<divclass="block">This applies this <ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html"title="class in io.github.thebusybiscuit.slimefun4.api.player"><code>StatusEffect</code></a> to the given <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a>.</div>
</td>
</tr>
<trid="i2"class="altColor">
<tdclass="colFirst"><code>void</code></td>
<tdclass="colLast"><code><spanclass="memberNameLink"><ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html#addPermanent-org.bukkit.entity.Player-int-">addPermanent</a></span>(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity">Player</a> p,
int level)</code>
<divclass="block">This applies this <ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html"title="class in io.github.thebusybiscuit.slimefun4.api.player"><code>StatusEffect</code></a> to the given <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a>.</div>
</td>
</tr>
<trid="i3"class="rowColor">
<tdclass="colFirst"><code>void</code></td>
<tdclass="colLast"><code><spanclass="memberNameLink"><ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html#clear-org.bukkit.entity.Player-">clear</a></span>(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity">Player</a> p)</code>
<divclass="block">This will remove this <ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html"title="class in io.github.thebusybiscuit.slimefun4.api.player"><code>StatusEffect</code></a> from the given <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a>.</div>
</td>
</tr>
<trid="i4"class="altColor">
<tdclass="colFirst"><code><ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/NamespacedKey.html?is-external=true"title="class or interface in org.bukkit">NamespacedKey</a></code></td>
<tdclass="colLast"><code><spanclass="memberNameLink"><ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html#getLevel-org.bukkit.entity.Player-">getLevel</a></span>(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity">Player</a> p)</code>
<divclass="block">This method returns an <code>OptionalInt</code> describing the level of this status
effect on that player.</div>
</td>
</tr>
<trid="i6"class="altColor">
<tdclass="colFirst"><code>boolean</code></td>
<tdclass="colLast"><code><spanclass="memberNameLink"><ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html#isPresent-org.bukkit.entity.Player-">isPresent</a></span>(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity">Player</a> p)</code>
<divclass="block">This will check whether this <ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html"title="class in io.github.thebusybiscuit.slimefun4.api.player"><code>StatusEffect</code></a> is currently applied
to that <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a>.</div>
<pre>public StatusEffect(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/NamespacedKey.html?is-external=true"title="class or interface in org.bukkit">NamespacedKey</a> key)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ulclass="blockList">
<liclass="blockList"><aname="method.detail">
<!---->
</a>
<h3>Method Detail</h3>
<aname="getKey--">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>getKey</h4>
<pre>public <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/NamespacedKey.html?is-external=true"title="class or interface in org.bukkit">NamespacedKey</a> getKey()</pre>
<dd><code><ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Keyed.html?is-external=true#getKey--"title="class or interface in org.bukkit">getKey</a></code> in interface <code><ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Keyed.html?is-external=true"title="class or interface in org.bukkit">Keyed</a></code></dd>
<pre>public void add(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity">Player</a> p,
int duration,
java.util.concurrent.TimeUnit unit)</pre>
<divclass="block">This applies this <ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html"title="class in io.github.thebusybiscuit.slimefun4.api.player"><code>StatusEffect</code></a> to the given <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a>.
You can specify a duration, this will reference
<ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html#add-org.bukkit.entity.Player-int-int-java.util.concurrent.TimeUnit-"><code>add(Player, int, int, TimeUnit)</code></a> with a level of 1.</div>
<dd><code>p</code> - The <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a> whom to apply the effect to</dd>
<dd><code>duration</code> - The duration of how long that status effect shall last</dd>
<dd><code>unit</code> - The <code>TimeUnit</code> for the given duration</dd>
<pre>public void add(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity">Player</a> p,
int level,
int duration,
java.util.concurrent.TimeUnit unit)</pre>
<divclass="block">This applies this <ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html"title="class in io.github.thebusybiscuit.slimefun4.api.player"><code>StatusEffect</code></a> to the given <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a>.</div>
<dd><code>p</code> - The <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a> whom to apply the effect to</dd>
<dd><code>level</code> - The level of this effect</dd>
<dd><code>duration</code> - The duration of how long that status effect shall last</dd>
<dd><code>unit</code> - The <code>TimeUnit</code> for the given duration</dd>
<pre>public void addPermanent(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity">Player</a> p,
int level)</pre>
<divclass="block">This applies this <ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html"title="class in io.github.thebusybiscuit.slimefun4.api.player"><code>StatusEffect</code></a> to the given <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a>.
This will apply it permanently, there is no duration.</div>
<dd><code>p</code> - The <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a> whom to apply the effect to</dd>
<dd><code>level</code> - The level of this effect</dd>
</dl>
</li>
</ul>
<aname="isPresent-org.bukkit.entity.Player-">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>isPresent</h4>
<pre>public boolean isPresent(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity">Player</a> p)</pre>
<divclass="block">This will check whether this <ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html"title="class in io.github.thebusybiscuit.slimefun4.api.player"><code>StatusEffect</code></a> is currently applied
to that <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a>.
If the effect has expired, it will automatically remove all associated
<dd><code>p</code> - The <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a> to check for</dd>
<dt><spanclass="returnLabel">Returns:</span></dt>
<dd>Whether this <ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html"title="class in io.github.thebusybiscuit.slimefun4.api.player"><code>StatusEffect</code></a> is currently applied</dd>
</dl>
</li>
</ul>
<aname="getLevel-org.bukkit.entity.Player-">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>getLevel</h4>
<pre>public java.util.OptionalInt getLevel(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity">Player</a> p)</pre>
<divclass="block">This method returns an <code>OptionalInt</code> describing the level of this status
<dd><code>p</code> - The <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a> to check for</dd>
<dt><spanclass="returnLabel">Returns:</span></dt>
<dd>An <code>OptionalInt</code> that describes the result</dd>
</dl>
</li>
</ul>
<aname="clear-org.bukkit.entity.Player-">
<!---->
</a>
<ulclass="blockListLast">
<liclass="blockList">
<h4>clear</h4>
<pre>public void clear(<ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity">Player</a> p)</pre>
<divclass="block">This will remove this <ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/StatusEffect.html"title="class in io.github.thebusybiscuit.slimefun4.api.player"><code>StatusEffect</code></a> from the given <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a>.</div>
<dd><code>p</code> - The <ahref="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true"title="class or interface in org.bukkit.entity"><code>Player</code></a> to clear it from</dd>
<li><ahref="../../../../../../io/github/thebusybiscuit/slimefun4/api/player/PlayerBackpack.html"title="class in io.github.thebusybiscuit.slimefun4.api.player"><spanclass="typeNameLink">Prev Class</span></a></li>