Scissors-Website/public/javadoc/1.17.1/org/bukkit/enchantments/EnchantmentWrapper.html
2022-07-05 18:33:56 -05:00

506 lines
44 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>EnchantmentWrapper (Scissors-API 1.17.1-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.enchantments, class: EnchantmentWrapper">
<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.5.1.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="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>Nested&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.enchantments</a></div>
<h1 title="Class EnchantmentWrapper" class="title">Class EnchantmentWrapper</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="Enchantment.html" title="class in org.bukkit.enchantments">org.bukkit.enchantments.Enchantment</a>
<div class="inheritance">org.bukkit.enchantments.EnchantmentWrapper</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://jd.adventure.kyori.net/api/4.9.3/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">EnchantmentWrapper</span>
<span class="extends-implements">extends <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span></div>
<div class="block">A simple wrapper for ease of selecting <a href="Enchantment.html" title="class in org.bukkit.enchantments"><code>Enchantment</code></a>s</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== 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.enchantments.Enchantment">Fields inherited from class&nbsp;org.bukkit.enchantments.<a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></h3>
<code><a href="Enchantment.html#ARROW_DAMAGE">ARROW_DAMAGE</a>, <a href="Enchantment.html#ARROW_FIRE">ARROW_FIRE</a>, <a href="Enchantment.html#ARROW_INFINITE">ARROW_INFINITE</a>, <a href="Enchantment.html#ARROW_KNOCKBACK">ARROW_KNOCKBACK</a>, <a href="Enchantment.html#BINDING_CURSE">BINDING_CURSE</a>, <a href="Enchantment.html#CHANNELING">CHANNELING</a>, <a href="Enchantment.html#DAMAGE_ALL">DAMAGE_ALL</a>, <a href="Enchantment.html#DAMAGE_ARTHROPODS">DAMAGE_ARTHROPODS</a>, <a href="Enchantment.html#DAMAGE_UNDEAD">DAMAGE_UNDEAD</a>, <a href="Enchantment.html#DEPTH_STRIDER">DEPTH_STRIDER</a>, <a href="Enchantment.html#DIG_SPEED">DIG_SPEED</a>, <a href="Enchantment.html#DURABILITY">DURABILITY</a>, <a href="Enchantment.html#FIRE_ASPECT">FIRE_ASPECT</a>, <a href="Enchantment.html#FROST_WALKER">FROST_WALKER</a>, <a href="Enchantment.html#IMPALING">IMPALING</a>, <a href="Enchantment.html#KNOCKBACK">KNOCKBACK</a>, <a href="Enchantment.html#LOOT_BONUS_BLOCKS">LOOT_BONUS_BLOCKS</a>, <a href="Enchantment.html#LOOT_BONUS_MOBS">LOOT_BONUS_MOBS</a>, <a href="Enchantment.html#LOYALTY">LOYALTY</a>, <a href="Enchantment.html#LUCK">LUCK</a>, <a href="Enchantment.html#LURE">LURE</a>, <a href="Enchantment.html#MENDING">MENDING</a>, <a href="Enchantment.html#MULTISHOT">MULTISHOT</a>, <a href="Enchantment.html#OXYGEN">OXYGEN</a>, <a href="Enchantment.html#PIERCING">PIERCING</a>, <a href="Enchantment.html#PROTECTION_ENVIRONMENTAL">PROTECTION_ENVIRONMENTAL</a>, <a href="Enchantment.html#PROTECTION_EXPLOSIONS">PROTECTION_EXPLOSIONS</a>, <a href="Enchantment.html#PROTECTION_FALL">PROTECTION_FALL</a>, <a href="Enchantment.html#PROTECTION_FIRE">PROTECTION_FIRE</a>, <a href="Enchantment.html#PROTECTION_PROJECTILE">PROTECTION_PROJECTILE</a>, <a href="Enchantment.html#QUICK_CHARGE">QUICK_CHARGE</a>, <a href="Enchantment.html#RIPTIDE">RIPTIDE</a>, <a href="Enchantment.html#SILK_TOUCH">SILK_TOUCH</a>, <a href="Enchantment.html#SOUL_SPEED">SOUL_SPEED</a>, <a href="Enchantment.html#SWEEPING_EDGE">SWEEPING_EDGE</a>, <a href="Enchantment.html#THORNS">THORNS</a>, <a href="Enchantment.html#VANISHING_CURSE">VANISHING_CURSE</a>, <a href="Enchantment.html#WATER_WORKER">WATER_WORKER</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 two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">EnchantmentWrapper</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canEnchantItem(org.bukkit.inventory.ItemStack)" class="member-name-link">canEnchantItem</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a>&nbsp;item)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Checks if this Enchantment may be applied to the given <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>ItemStack</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#conflictsWith(org.bukkit.enchantments.Enchantment)" class="member-name-link">conflictsWith</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a>&nbsp;other)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Check if this enchantment conflicts with another enchantment.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://jd.adventure.kyori.net/api/4.9.3/net/kyori/adventure/text/Component.html" title="class or interface in net.kyori.adventure.text" class="external-link">Component</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#displayName(int)" class="member-name-link">displayName</a><wbr>(int&nbsp;level)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the name of the enchantment with its applied level.</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/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../inventory/EquipmentSlot.html" title="enum class in org.bukkit.inventory">EquipmentSlot</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="#getActiveSlots()" class="member-name-link">getActiveSlots</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 equipment slots where this enchantment is considered "active".</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>float</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDamageIncrease(int,org.bukkit.entity.EntityCategory)" class="member-name-link">getDamageIncrease</a><wbr>(int&nbsp;level,
<a href="../entity/EntityCategory.html" title="enum class in org.bukkit.entity">EntityCategory</a>&nbsp;entityCategory)</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 damage increase as a result of the level and entity category specified</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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEnchantment()" class="member-name-link">getEnchantment</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 enchantment 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><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="EnchantmentTarget.html" title="enum class in org.bukkit.enchantments">EnchantmentTarget</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getItemTarget()" class="member-name-link">getItemTarget</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 type of <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>ItemStack</code></a> that may fit this Enchantment.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxLevel()" class="member-name-link">getMaxLevel</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 maximum level that this Enchantment may become.</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/21.0.1/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">Gets the unique name of this enchantment</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../io/papermc/paper/enchantments/EnchantmentRarity.html" title="enum class in io.papermc.paper.enchantments">EnchantmentRarity</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRarity()" class="member-name-link">getRarity</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 rarity of this enchantment.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStartLevel()" class="member-name-link">getStartLevel</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 level that this Enchantment should start at</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCursed()" class="member-name-link">isCursed</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Checks if this enchantment is a cursed enchantment
<br>
Cursed enchantments are found the same way treasure enchantments are</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="#isDiscoverable()" class="member-name-link">isDiscoverable</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Checks if this enchantment can be found in an enchanting table
or use to enchant items generated by loot tables.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isTradeable()" class="member-name-link">isTradeable</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Checks if this enchantment can be found in villager trades.</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="#isTreasure()" class="member-name-link">isTreasure</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Checks if this enchantment is a treasure enchantment.</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/21.0.1/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.enchantments.Enchantment">Methods inherited from class&nbsp;org.bukkit.enchantments.<a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></h3>
<code><a href="Enchantment.html#equals(java.lang.Object)">equals</a>, <a href="Enchantment.html#getByKey(org.bukkit.NamespacedKey)">getByKey</a>, <a href="Enchantment.html#getByName(java.lang.String)">getByName</a>, <a href="Enchantment.html#getKey()">getKey</a>, <a href="Enchantment.html#hashCode()">hashCode</a>, <a href="Enchantment.html#isAcceptingRegistrations()">isAcceptingRegistrations</a>, <a href="Enchantment.html#registerEnchantment(org.bukkit.enchantments.Enchantment)">registerEnchantment</a>, <a href="Enchantment.html#stopAcceptingRegistrations()">stopAcceptingRegistrations</a>, <a href="Enchantment.html#toString()">toString</a>, <a href="Enchantment.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>
</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;(java.lang.String)">
<h3>EnchantmentWrapper</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">EnchantmentWrapper</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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/21.0.1/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="getEnchantment()">
<h3>getEnchantment</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span>&nbsp;<span class="element-name">getEnchantment</span>()</div>
<div class="block">Gets the enchantment bound to this wrapper</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Enchantment</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getMaxLevel()">
<h3>getMaxLevel</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getMaxLevel</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Enchantment.html#getMaxLevel()">Enchantment</a></code></span></div>
<div class="block">Gets the maximum level that this Enchantment may become.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#getMaxLevel()">getMaxLevel</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Returns:</dt>
<dd>Maximum level of the Enchantment</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getStartLevel()">
<h3>getStartLevel</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getStartLevel</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Enchantment.html#getStartLevel()">Enchantment</a></code></span></div>
<div class="block">Gets the level that this Enchantment should start at</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#getStartLevel()">getStartLevel</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Returns:</dt>
<dd>Starting level of the Enchantment</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getItemTarget()">
<h3>getItemTarget</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="EnchantmentTarget.html" title="enum class in org.bukkit.enchantments">EnchantmentTarget</a></span>&nbsp;<span class="element-name">getItemTarget</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Enchantment.html#getItemTarget()">Enchantment</a></code></span></div>
<div class="block">Gets the type of <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>ItemStack</code></a> that may fit this Enchantment.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#getItemTarget()">getItemTarget</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Returns:</dt>
<dd>Target type of the Enchantment</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="canEnchantItem(org.bukkit.inventory.ItemStack)">
<h3>canEnchantItem</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">canEnchantItem</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a>&nbsp;item)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Enchantment.html#canEnchantItem(org.bukkit.inventory.ItemStack)">Enchantment</a></code></span></div>
<div class="block">Checks if this Enchantment may be applied to the given <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>ItemStack</code></a>.
<p>
This does not check if it conflicts with any enchantments already
applied to the item.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#canEnchantItem(org.bukkit.inventory.ItemStack)">canEnchantItem</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Parameters:</dt>
<dd><code>item</code> - Item to test</dd>
<dt>Returns:</dt>
<dd>True if the enchantment may be applied, otherwise False</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/21.0.1/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/21.0.1/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="Enchantment.html#getName()">Enchantment</a></code></span></div>
<div class="block">Gets the unique name of this enchantment</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#getName()">getName</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Returns:</dt>
<dd>Unique name</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isTreasure()">
<h3>isTreasure</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isTreasure</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Enchantment.html#isTreasure()">Enchantment</a></code></span></div>
<div class="block">Checks if this enchantment is a treasure enchantment.
<br>
Treasure enchantments can only be received via looting, trading, or
fishing.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#isTreasure()">isTreasure</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Returns:</dt>
<dd>true if the enchantment is a treasure enchantment</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isCursed()">
<h3>isCursed</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isCursed</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Enchantment.html#isCursed()">Enchantment</a></code></span></div>
<div class="block">Checks if this enchantment is a cursed enchantment
<br>
Cursed enchantments are found the same way treasure enchantments are</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#isCursed()">isCursed</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Returns:</dt>
<dd>true if the enchantment is cursed</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="conflictsWith(org.bukkit.enchantments.Enchantment)">
<h3>conflictsWith</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">conflictsWith</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a>&nbsp;other)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Enchantment.html#conflictsWith(org.bukkit.enchantments.Enchantment)">Enchantment</a></code></span></div>
<div class="block">Check if this enchantment conflicts with another enchantment.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#conflictsWith(org.bukkit.enchantments.Enchantment)">conflictsWith</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Parameters:</dt>
<dd><code>other</code> - The enchantment to check against</dd>
<dt>Returns:</dt>
<dd>True if there is a conflict.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="displayName(int)">
<h3>displayName</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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://jd.adventure.kyori.net/api/4.9.3/net/kyori/adventure/text/Component.html" title="class or interface in net.kyori.adventure.text" class="external-link">Component</a></span>&nbsp;<span class="element-name">displayName</span><wbr><span class="parameters">(int&nbsp;level)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Enchantment.html#displayName(int)">Enchantment</a></code></span></div>
<div class="block">Get the name of the enchantment with its applied level.
<p>
If the given <code>level</code> is either less than the <a href="Enchantment.html#getStartLevel()"><code>Enchantment.getStartLevel()</code></a> or greater than the <a href="Enchantment.html#getMaxLevel()"><code>Enchantment.getMaxLevel()</code></a>,
the level may not be shown in the numeral format one may otherwise expect.
</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#displayName(int)">displayName</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Parameters:</dt>
<dd><code>level</code> - the level of the enchantment to show</dd>
<dt>Returns:</dt>
<dd>the name of the enchantment with <code>level</code> applied</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/21.0.1/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/21.0.1/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.adventure.kyori.net/api/4.9.3/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>
<li>
<section class="detail" id="isTradeable()">
<h3>isTradeable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isTradeable</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Enchantment.html#isTradeable()">Enchantment</a></code></span></div>
<div class="block">Checks if this enchantment can be found in villager trades.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#isTradeable()">isTradeable</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Returns:</dt>
<dd>true if the enchantment can be found in trades</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isDiscoverable()">
<h3>isDiscoverable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isDiscoverable</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Enchantment.html#isDiscoverable()">Enchantment</a></code></span></div>
<div class="block">Checks if this enchantment can be found in an enchanting table
or use to enchant items generated by loot tables.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#isDiscoverable()">isDiscoverable</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Returns:</dt>
<dd>true if the enchantment can be found in a table or by loot tables</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getRarity()">
<h3>getRarity</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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="../../../io/papermc/paper/enchantments/EnchantmentRarity.html" title="enum class in io.papermc.paper.enchantments">EnchantmentRarity</a></span>&nbsp;<span class="element-name">getRarity</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Enchantment.html#getRarity()">Enchantment</a></code></span></div>
<div class="block">Gets the rarity of this enchantment.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#getRarity()">getRarity</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Returns:</dt>
<dd>the rarity</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDamageIncrease(int,org.bukkit.entity.EntityCategory)">
<h3>getDamageIncrease</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">float</span>&nbsp;<span class="element-name">getDamageIncrease</span><wbr><span class="parameters">(int&nbsp;level,
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
<a href="../entity/EntityCategory.html" title="enum class in org.bukkit.entity">EntityCategory</a>&nbsp;entityCategory)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Enchantment.html#getDamageIncrease(int,org.bukkit.entity.EntityCategory)">Enchantment</a></code></span></div>
<div class="block">Gets the damage increase as a result of the level and entity category specified</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#getDamageIncrease(int,org.bukkit.entity.EntityCategory)">getDamageIncrease</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Parameters:</dt>
<dd><code>level</code> - the level of enchantment</dd>
<dd><code>entityCategory</code> - the category of entity</dd>
<dt>Returns:</dt>
<dd>the damage increase</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getActiveSlots()">
<h3>getActiveSlots</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/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/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../inventory/EquipmentSlot.html" title="enum class in org.bukkit.inventory">EquipmentSlot</a>&gt;</span>&nbsp;<span class="element-name">getActiveSlots</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Enchantment.html#getActiveSlots()">Enchantment</a></code></span></div>
<div class="block">Gets the equipment slots where this enchantment is considered "active".</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Enchantment.html#getActiveSlots()">getActiveSlots</a></code>&nbsp;in class&nbsp;<code><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></dd>
<dt>Returns:</dt>
<dd>the equipment slots</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>