Scissors-Website/javadoc/1.19.4/org/bukkit/potion/PotionEffectTypeWrapper.html
2023-04-02 20:49:18 -05:00

386 lines
33 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>PotionEffectTypeWrapper (Scissors-API 1.19.4-R0.1-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.bukkit.potion, class: PotionEffectTypeWrapper">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/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="../../../script-dir/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/PotionEffectTypeWrapper.html">Use</a></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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.bukkit.potion</a></div>
<h1 title="Class PotionEffectTypeWrapper" class="title">Class PotionEffectTypeWrapper</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="PotionEffectType.html" title="class in org.bukkit.potion">org.bukkit.potion.PotionEffectType</a>
<div class="inheritance">org.bukkit.potion.PotionEffectTypeWrapper</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code>net.kyori.adventure.key.Keyed</code>, <code><a href="https://jd.advntr.dev/api/4.13.0/net/kyori/adventure/translation/Translatable.html" title="class or interface in net.kyori.adventure.translation" class="external-link">Translatable</a></code>, <code><a href="../Keyed.html" title="interface in org.bukkit">Keyed</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">PotionEffectTypeWrapper</span>
<span class="extends-implements">extends <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.bukkit.potion.PotionEffectType">Nested classes/interfaces inherited from class&nbsp;org.bukkit.potion.<a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></h2>
<code><a href="PotionEffectType.Category.html" title="enum class in org.bukkit.potion">PotionEffectType.Category</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.bukkit.potion.PotionEffectType">Fields inherited from class&nbsp;org.bukkit.potion.<a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></h3>
<code><a href="PotionEffectType.html#ABSORPTION">ABSORPTION</a>, <a href="PotionEffectType.html#BAD_OMEN">BAD_OMEN</a>, <a href="PotionEffectType.html#BLINDNESS">BLINDNESS</a>, <a href="PotionEffectType.html#CONDUIT_POWER">CONDUIT_POWER</a>, <a href="PotionEffectType.html#CONFUSION">CONFUSION</a>, <a href="PotionEffectType.html#DAMAGE_RESISTANCE">DAMAGE_RESISTANCE</a>, <a href="PotionEffectType.html#DARKNESS">DARKNESS</a>, <a href="PotionEffectType.html#DOLPHINS_GRACE">DOLPHINS_GRACE</a>, <a href="PotionEffectType.html#FAST_DIGGING">FAST_DIGGING</a>, <a href="PotionEffectType.html#FIRE_RESISTANCE">FIRE_RESISTANCE</a>, <a href="PotionEffectType.html#GLOWING">GLOWING</a>, <a href="PotionEffectType.html#HARM">HARM</a>, <a href="PotionEffectType.html#HEAL">HEAL</a>, <a href="PotionEffectType.html#HEALTH_BOOST">HEALTH_BOOST</a>, <a href="PotionEffectType.html#HERO_OF_THE_VILLAGE">HERO_OF_THE_VILLAGE</a>, <a href="PotionEffectType.html#HUNGER">HUNGER</a>, <a href="PotionEffectType.html#INCREASE_DAMAGE">INCREASE_DAMAGE</a>, <a href="PotionEffectType.html#INVISIBILITY">INVISIBILITY</a>, <a href="PotionEffectType.html#JUMP">JUMP</a>, <a href="PotionEffectType.html#LEVITATION">LEVITATION</a>, <a href="PotionEffectType.html#LUCK">LUCK</a>, <a href="PotionEffectType.html#NIGHT_VISION">NIGHT_VISION</a>, <a href="PotionEffectType.html#POISON">POISON</a>, <a href="PotionEffectType.html#REGENERATION">REGENERATION</a>, <a href="PotionEffectType.html#SATURATION">SATURATION</a>, <a href="PotionEffectType.html#SLOW">SLOW</a>, <a href="PotionEffectType.html#SLOW_DIGGING">SLOW_DIGGING</a>, <a href="PotionEffectType.html#SLOW_FALLING">SLOW_FALLING</a>, <a href="PotionEffectType.html#SPEED">SPEED</a>, <a href="PotionEffectType.html#UNLUCK">UNLUCK</a>, <a href="PotionEffectType.html#WATER_BREATHING">WATER_BREATHING</a>, <a href="PotionEffectType.html#WEAKNESS">WEAKNESS</a>, <a href="PotionEffectType.html#WITHER">WITHER</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,java.lang.String)" class="member-name-link">PotionEffectTypeWrapper</a><wbr>(int&nbsp;id,
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAttributeModifierAmount(org.bukkit.attribute.Attribute,int)" class="member-name-link">getAttributeModifierAmount</a><wbr>(<a href="../attribute/Attribute.html" title="enum class in org.bukkit.attribute">Attribute</a>&nbsp;attribute,
int&nbsp;effectAmplifier)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the true modifier amount based on the effect amplifier.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Color.html" title="class in org.bukkit">Color</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getColor()" class="member-name-link">getColor</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the color of this effect type.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDurationModifier()" class="member-name-link">getDurationModifier</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the duration modifier applied to effects of this type.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../attribute/Attribute.html" title="enum class in org.bukkit.attribute">Attribute</a>,<wbr><a href="../attribute/AttributeModifier.html" title="class in org.bukkit.attribute">AttributeModifier</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEffectAttributes()" class="member-name-link">getEffectAttributes</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the effect attributes in an immutable map.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="PotionEffectType.Category.html" title="enum class in org.bukkit.potion">PotionEffectType.Category</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEffectCategory()" class="member-name-link">getEffectCategory</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the category of this effect</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getKey()" class="member-name-link">getKey</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return the namespaced identifier for this object.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the name of this effect type.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getType()" class="member-name-link">getType</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the potion type bound to this wrapper.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isInstant()" class="member-name-link">isInstant</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns whether the effect of this type happens once, immediately.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#translationKey()" class="member-name-link">translationKey</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the translation key.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.bukkit.potion.PotionEffectType">Methods inherited from class&nbsp;org.bukkit.potion.<a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></h3>
<code><a href="PotionEffectType.html#createEffect(int,int)">createEffect</a>, <a href="PotionEffectType.html#equals(java.lang.Object)">equals</a>, <a href="PotionEffectType.html#getById(int)">getById</a>, <a href="PotionEffectType.html#getByKey(org.bukkit.NamespacedKey)">getByKey</a>, <a href="PotionEffectType.html#getByName(java.lang.String)">getByName</a>, <a href="PotionEffectType.html#getId()">getId</a>, <a href="PotionEffectType.html#hashCode()">hashCode</a>, <a href="PotionEffectType.html#registerPotionEffectType(org.bukkit.potion.PotionEffectType)">registerPotionEffectType</a>, <a href="PotionEffectType.html#stopAcceptingRegistrations()">stopAcceptingRegistrations</a>, <a href="PotionEffectType.html#toString()">toString</a>, <a href="PotionEffectType.html#values()">values</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.bukkit.Keyed">Methods inherited from interface&nbsp;org.bukkit.<a href="../Keyed.html" title="interface in org.bukkit">Keyed</a></h3>
<code><a href="../Keyed.html#key()">key</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(int,java.lang.String)">
<h3>PotionEffectTypeWrapper</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">PotionEffectTypeWrapper</span><wbr><span class="parameters">(int&nbsp;id,
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getDurationModifier()">
<h3>getDurationModifier</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getDurationModifier</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="PotionEffectType.html#getDurationModifier()">PotionEffectType</a></code></span></div>
<div class="block">Returns the duration modifier applied to effects of this type.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="PotionEffectType.html#getDurationModifier()">getDurationModifier</a></code>&nbsp;in class&nbsp;<code><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></dd>
<dt>Returns:</dt>
<dd>duration modifier</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getName()">
<h3>getName</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getName</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="PotionEffectType.html#getName()">PotionEffectType</a></code></span></div>
<div class="block">Returns the name of this effect type.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="PotionEffectType.html#getName()">getName</a></code>&nbsp;in class&nbsp;<code><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></dd>
<dt>Returns:</dt>
<dd>The name of this effect type</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getType()">
<h3>getType</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span>&nbsp;<span class="element-name">getType</span>()</div>
<div class="block">Get the potion type bound to this wrapper.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The potion effect type</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isInstant()">
<h3>isInstant</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isInstant</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="PotionEffectType.html#isInstant()">PotionEffectType</a></code></span></div>
<div class="block">Returns whether the effect of this type happens once, immediately.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="PotionEffectType.html#isInstant()">isInstant</a></code>&nbsp;in class&nbsp;<code><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></dd>
<dt>Returns:</dt>
<dd>whether this type is normally instant</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getColor()">
<h3>getColor</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Color.html" title="class in org.bukkit">Color</a></span>&nbsp;<span class="element-name">getColor</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="PotionEffectType.html#getColor()">PotionEffectType</a></code></span></div>
<div class="block">Returns the color of this effect type.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="PotionEffectType.html#getColor()">getColor</a></code>&nbsp;in class&nbsp;<code><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></dd>
<dt>Returns:</dt>
<dd>the color</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getKey()">
<h3>getKey</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a></span>&nbsp;<span class="element-name">getKey</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Keyed.html#getKey()">Keyed</a></code></span></div>
<div class="block">Return the namespaced identifier for this object.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Keyed.html#getKey()">getKey</a></code>&nbsp;in interface&nbsp;<code><a href="../Keyed.html" title="interface in org.bukkit">Keyed</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="PotionEffectType.html#getKey()">getKey</a></code>&nbsp;in class&nbsp;<code><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></dd>
<dt>Returns:</dt>
<dd>this object's key</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getEffectAttributes()">
<h3>getEffectAttributes</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../attribute/Attribute.html" title="enum class in org.bukkit.attribute">Attribute</a>,<wbr><a href="../attribute/AttributeModifier.html" title="class in org.bukkit.attribute">AttributeModifier</a>&gt;</span>&nbsp;<span class="element-name">getEffectAttributes</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="PotionEffectType.html#getEffectAttributes()">PotionEffectType</a></code></span></div>
<div class="block">Gets the effect attributes in an immutable map.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="PotionEffectType.html#getEffectAttributes()">getEffectAttributes</a></code>&nbsp;in class&nbsp;<code><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></dd>
<dt>Returns:</dt>
<dd>the attribute map</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAttributeModifierAmount(org.bukkit.attribute.Attribute,int)">
<h3>getAttributeModifierAmount</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getAttributeModifierAmount</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
<a href="../attribute/Attribute.html" title="enum class in org.bukkit.attribute">Attribute</a>&nbsp;attribute,
int&nbsp;effectAmplifier)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="PotionEffectType.html#getAttributeModifierAmount(org.bukkit.attribute.Attribute,int)">PotionEffectType</a></code></span></div>
<div class="block">Gets the true modifier amount based on the effect amplifier.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="PotionEffectType.html#getAttributeModifierAmount(org.bukkit.attribute.Attribute,int)">getAttributeModifierAmount</a></code>&nbsp;in class&nbsp;<code><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></dd>
<dt>Parameters:</dt>
<dd><code>attribute</code> - the attribute</dd>
<dd><code>effectAmplifier</code> - the effect amplifier (0 indexed)</dd>
<dt>Returns:</dt>
<dd>the modifier amount</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getEffectCategory()">
<h3>getEffectCategory</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PotionEffectType.Category.html" title="enum class in org.bukkit.potion">PotionEffectType.Category</a></span>&nbsp;<span class="element-name">getEffectCategory</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="PotionEffectType.html#getEffectCategory()">PotionEffectType</a></code></span></div>
<div class="block">Gets the category of this effect</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="PotionEffectType.html#getEffectCategory()">getEffectCategory</a></code>&nbsp;in class&nbsp;<code><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></dd>
<dt>Returns:</dt>
<dd>the category</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="translationKey()">
<h3>translationKey</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">translationKey</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="https://jd.advntr.dev/api/4.13.0/net/kyori/adventure/translation/Translatable.html#translationKey()" title="class or interface in net.kyori.adventure.translation" class="external-link">net.kyori.adventure.translation.Translatable</a></code></span></div>
<div class="block">Gets the translation key.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the translation key</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>