mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2024-07-03 07:30:02 +00:00
1080 lines
83 KiB
HTML
1080 lines
83 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>Enchantment (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: Enchantment">
|
|
<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: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field-summary">Field</a> | </li>
|
|
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li><a href="#field-detail">Field</a> | </li>
|
|
<li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">org.bukkit.enchantments</a></div>
|
|
<h1 title="Class Enchantment" class="title">Class Enchantment</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">org.bukkit.enchantments.Enchantment</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>
|
|
<dl class="notes">
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><code><a href="EnchantmentWrapper.html" title="class in org.bukkit.enchantments">EnchantmentWrapper</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">Enchantment</span>
|
|
<span class="extends-implements">extends <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>
|
|
implements <a href="../Keyed.html" title="interface in org.bukkit">Keyed</a>, <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></span></div>
|
|
<div class="block">The various type of enchantments that may be added to armour or weapons</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="caption"><span>Fields</span></div>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Field</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#ARROW_DAMAGE" class="member-name-link">ARROW_DAMAGE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Provides extra damage when shooting arrows from bows</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#ARROW_FIRE" class="member-name-link">ARROW_FIRE</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Sets entities on fire when hit by arrows shot from a bow</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#ARROW_INFINITE" class="member-name-link">ARROW_INFINITE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Provides infinite arrows when shooting a bow</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#ARROW_KNOCKBACK" class="member-name-link">ARROW_KNOCKBACK</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Provides a knockback when an entity is hit by an arrow from a bow</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#BINDING_CURSE" class="member-name-link">BINDING_CURSE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Item cannot be removed</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#CHANNELING" class="member-name-link">CHANNELING</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Strikes lightning when a mob is hit with a trident if conditions are
|
|
stormy</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#DAMAGE_ALL" class="member-name-link">DAMAGE_ALL</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Increases damage against all targets</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#DAMAGE_ARTHROPODS" class="member-name-link">DAMAGE_ARTHROPODS</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Increases damage against arthropod targets</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#DAMAGE_UNDEAD" class="member-name-link">DAMAGE_UNDEAD</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Increases damage against undead targets</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#DEPTH_STRIDER" class="member-name-link">DEPTH_STRIDER</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Increases walking speed while in water</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#DIG_SPEED" class="member-name-link">DIG_SPEED</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Increases the rate at which you mine/dig</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#DURABILITY" class="member-name-link">DURABILITY</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Decreases the rate at which a tool looses durability</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#FIRE_ASPECT" class="member-name-link">FIRE_ASPECT</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">When attacking a target, has a chance to set them on fire</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#FROST_WALKER" class="member-name-link">FROST_WALKER</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Freezes any still water adjacent to ice / frost which player is walking on</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#IMPALING" class="member-name-link">IMPALING</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Deals more damage to mobs that live in the ocean</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#KNOCKBACK" class="member-name-link">KNOCKBACK</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">All damage to other targets will knock them back when hit</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#LOOT_BONUS_BLOCKS" class="member-name-link">LOOT_BONUS_BLOCKS</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Provides a chance of gaining extra loot when destroying blocks</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#LOOT_BONUS_MOBS" class="member-name-link">LOOT_BONUS_MOBS</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Provides a chance of gaining extra loot when killing monsters</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#LOYALTY" class="member-name-link">LOYALTY</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Causes a thrown trident to return to the player who threw it</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#LUCK" class="member-name-link">LUCK</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Decreases odds of catching worthless junk</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#LURE" class="member-name-link">LURE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Increases rate of fish biting your hook</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#MENDING" class="member-name-link">MENDING</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Allows mending the item using experience orbs</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#MULTISHOT" class="member-name-link">MULTISHOT</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Shoot multiple arrows from crossbows</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#OXYGEN" class="member-name-link">OXYGEN</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Decreases the rate of air loss whilst underwater</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#PIERCING" class="member-name-link">PIERCING</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Crossbow projectiles pierce entities</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#PROTECTION_ENVIRONMENTAL" class="member-name-link">PROTECTION_ENVIRONMENTAL</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Provides protection against environmental damage</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#PROTECTION_EXPLOSIONS" class="member-name-link">PROTECTION_EXPLOSIONS</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Provides protection against explosive damage</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#PROTECTION_FALL" class="member-name-link">PROTECTION_FALL</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Provides protection against fall damage</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#PROTECTION_FIRE" class="member-name-link">PROTECTION_FIRE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Provides protection against fire damage</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#PROTECTION_PROJECTILE" class="member-name-link">PROTECTION_PROJECTILE</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Provides protection against projectile damage</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#QUICK_CHARGE" class="member-name-link">QUICK_CHARGE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Charges crossbows quickly</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#RIPTIDE" class="member-name-link">RIPTIDE</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">When it is rainy, launches the player in the direction their trident is thrown</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#SILK_TOUCH" class="member-name-link">SILK_TOUCH</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Allows blocks to drop themselves instead of fragments (for example,
|
|
stone instead of cobblestone)</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#SOUL_SPEED" class="member-name-link">SOUL_SPEED</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Walk quicker on soul blocks</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#SWEEPING_EDGE" class="member-name-link">SWEEPING_EDGE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Increases damage against targets when using a sweep attack</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#THORNS" class="member-name-link">THORNS</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Damages the attacker</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#VANISHING_CURSE" class="member-name-link">VANISHING_CURSE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Item disappears instead of dropping</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#WATER_WORKER" class="member-name-link">WATER_WORKER</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Increases the speed at which a player may mine underwater</div>
|
|
</div>
|
|
</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(org.bukkit.NamespacedKey)" class="member-name-link">Enchantment</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="../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a> key)</code></div>
|
|
<div class="col-last even-row-color"> </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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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-tab3"><code>abstract boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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> item)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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-tab3"><code>abstract boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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> other)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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-tab3"><code>abstract <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-tab3"><code><a href="#displayName(int)" class="member-name-link">displayName</a><wbr>(int level)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<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> obj)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <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><<a href="../inventory/EquipmentSlot.html" title="enum class in org.bukkit.inventory">EquipmentSlot</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getActiveSlots()" class="member-name-link">getActiveSlots</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Gets the equipment slots where this enchantment is considered "active".</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</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-tab1 method-summary-table-tab4"><code><a href="#getByKey(org.bukkit.NamespacedKey)" class="member-name-link">getByKey</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a> key)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets the Enchantment at the specified key</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getByName(java.lang.String)" class="member-name-link">getByName</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</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> name)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">enchantments are badly named, use <a href="#getByKey(org.bukkit.NamespacedKey)"><code>getByKey(org.bukkit.NamespacedKey)</code></a>.</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract float</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDamageIncrease(int,org.bukkit.entity.EntityCategory)" class="member-name-link">getDamageIncrease</a><wbr>(int level,
|
|
<a href="../entity/EntityCategory.html" title="enum class in org.bukkit.entity">EntityCategory</a> entityCategory)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Gets the damage increase as a result of the level and entity category specified</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <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-tab3"><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-tab3">
|
|
<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><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="../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-tab3"><code>abstract int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaxLevel()" class="member-name-link">getMaxLevel</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Gets the maximum level that this Enchantment may become.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>abstract <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-tab3 method-summary-table-tab6"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">enchantments are badly named, use <a href="#getKey()"><code>getKey()</code></a>.</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="../../../io/papermc/paper/enchantments/EnchantmentRarity.html" title="enum class in io.papermc.paper.enchantments">EnchantmentRarity</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRarity()" class="member-name-link">getRarity</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Gets the rarity of this enchantment.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getStartLevel()" class="member-name-link">getStartLevel</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Gets the level that this Enchantment should start at</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="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isAcceptingRegistrations()" class="member-name-link">isAcceptingRegistrations</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Checks if this is accepting Enchantment registrations.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isCursed()" class="member-name-link">isCursed</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isDiscoverable()" class="member-name-link">isDiscoverable</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isTradeable()" class="member-name-link">isTradeable</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Checks if this enchantment can be found in villager trades.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isTreasure()" class="member-name-link">isTreasure</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Checks if this enchantment is a treasure enchantment.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#registerEnchantment(org.bukkit.enchantments.Enchantment)" class="member-name-link">registerEnchantment</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> enchantment)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Registers an enchantment with the given ID and object.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#stopAcceptingRegistrations()" class="member-name-link">stopAcceptingRegistrations</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Stops accepting any enchantment registrations</div>
|
|
</div>
|
|
<div class="col-first even-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/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="#toString()" class="member-name-link">toString</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets an array of all the registered <a href="Enchantment.html" title="class in org.bukkit.enchantments"><code>Enchantment</code></a>s</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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-net.kyori.adventure.translation.Translatable">Methods inherited from interface net.kyori.adventure.translation.<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></h3>
|
|
<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">translationKey</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<li>
|
|
<section class="field-details" id="field-detail">
|
|
<h2>Field Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="PROTECTION_ENVIRONMENTAL">
|
|
<h3>PROTECTION_ENVIRONMENTAL</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">PROTECTION_ENVIRONMENTAL</span></div>
|
|
<div class="block">Provides protection against environmental damage</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="PROTECTION_FIRE">
|
|
<h3>PROTECTION_FIRE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">PROTECTION_FIRE</span></div>
|
|
<div class="block">Provides protection against fire damage</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="PROTECTION_FALL">
|
|
<h3>PROTECTION_FALL</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">PROTECTION_FALL</span></div>
|
|
<div class="block">Provides protection against fall damage</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="PROTECTION_EXPLOSIONS">
|
|
<h3>PROTECTION_EXPLOSIONS</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">PROTECTION_EXPLOSIONS</span></div>
|
|
<div class="block">Provides protection against explosive damage</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="PROTECTION_PROJECTILE">
|
|
<h3>PROTECTION_PROJECTILE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">PROTECTION_PROJECTILE</span></div>
|
|
<div class="block">Provides protection against projectile damage</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="OXYGEN">
|
|
<h3>OXYGEN</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">OXYGEN</span></div>
|
|
<div class="block">Decreases the rate of air loss whilst underwater</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="WATER_WORKER">
|
|
<h3>WATER_WORKER</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">WATER_WORKER</span></div>
|
|
<div class="block">Increases the speed at which a player may mine underwater</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="THORNS">
|
|
<h3>THORNS</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">THORNS</span></div>
|
|
<div class="block">Damages the attacker</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DEPTH_STRIDER">
|
|
<h3>DEPTH_STRIDER</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">DEPTH_STRIDER</span></div>
|
|
<div class="block">Increases walking speed while in water</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="FROST_WALKER">
|
|
<h3>FROST_WALKER</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">FROST_WALKER</span></div>
|
|
<div class="block">Freezes any still water adjacent to ice / frost which player is walking on</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="BINDING_CURSE">
|
|
<h3>BINDING_CURSE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">BINDING_CURSE</span></div>
|
|
<div class="block">Item cannot be removed</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DAMAGE_ALL">
|
|
<h3>DAMAGE_ALL</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">DAMAGE_ALL</span></div>
|
|
<div class="block">Increases damage against all targets</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DAMAGE_UNDEAD">
|
|
<h3>DAMAGE_UNDEAD</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">DAMAGE_UNDEAD</span></div>
|
|
<div class="block">Increases damage against undead targets</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DAMAGE_ARTHROPODS">
|
|
<h3>DAMAGE_ARTHROPODS</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">DAMAGE_ARTHROPODS</span></div>
|
|
<div class="block">Increases damage against arthropod targets</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="KNOCKBACK">
|
|
<h3>KNOCKBACK</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">KNOCKBACK</span></div>
|
|
<div class="block">All damage to other targets will knock them back when hit</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="FIRE_ASPECT">
|
|
<h3>FIRE_ASPECT</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">FIRE_ASPECT</span></div>
|
|
<div class="block">When attacking a target, has a chance to set them on fire</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="LOOT_BONUS_MOBS">
|
|
<h3>LOOT_BONUS_MOBS</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">LOOT_BONUS_MOBS</span></div>
|
|
<div class="block">Provides a chance of gaining extra loot when killing monsters</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="SWEEPING_EDGE">
|
|
<h3>SWEEPING_EDGE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">SWEEPING_EDGE</span></div>
|
|
<div class="block">Increases damage against targets when using a sweep attack</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DIG_SPEED">
|
|
<h3>DIG_SPEED</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">DIG_SPEED</span></div>
|
|
<div class="block">Increases the rate at which you mine/dig</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="SILK_TOUCH">
|
|
<h3>SILK_TOUCH</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">SILK_TOUCH</span></div>
|
|
<div class="block">Allows blocks to drop themselves instead of fragments (for example,
|
|
stone instead of cobblestone)</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DURABILITY">
|
|
<h3>DURABILITY</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">DURABILITY</span></div>
|
|
<div class="block">Decreases the rate at which a tool looses durability</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="LOOT_BONUS_BLOCKS">
|
|
<h3>LOOT_BONUS_BLOCKS</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">LOOT_BONUS_BLOCKS</span></div>
|
|
<div class="block">Provides a chance of gaining extra loot when destroying blocks</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="ARROW_DAMAGE">
|
|
<h3>ARROW_DAMAGE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">ARROW_DAMAGE</span></div>
|
|
<div class="block">Provides extra damage when shooting arrows from bows</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="ARROW_KNOCKBACK">
|
|
<h3>ARROW_KNOCKBACK</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">ARROW_KNOCKBACK</span></div>
|
|
<div class="block">Provides a knockback when an entity is hit by an arrow from a bow</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="ARROW_FIRE">
|
|
<h3>ARROW_FIRE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">ARROW_FIRE</span></div>
|
|
<div class="block">Sets entities on fire when hit by arrows shot from a bow</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="ARROW_INFINITE">
|
|
<h3>ARROW_INFINITE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">ARROW_INFINITE</span></div>
|
|
<div class="block">Provides infinite arrows when shooting a bow</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="LUCK">
|
|
<h3>LUCK</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">LUCK</span></div>
|
|
<div class="block">Decreases odds of catching worthless junk</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="LURE">
|
|
<h3>LURE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">LURE</span></div>
|
|
<div class="block">Increases rate of fish biting your hook</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="LOYALTY">
|
|
<h3>LOYALTY</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">LOYALTY</span></div>
|
|
<div class="block">Causes a thrown trident to return to the player who threw it</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="IMPALING">
|
|
<h3>IMPALING</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">IMPALING</span></div>
|
|
<div class="block">Deals more damage to mobs that live in the ocean</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="RIPTIDE">
|
|
<h3>RIPTIDE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">RIPTIDE</span></div>
|
|
<div class="block">When it is rainy, launches the player in the direction their trident is thrown</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="CHANNELING">
|
|
<h3>CHANNELING</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">CHANNELING</span></div>
|
|
<div class="block">Strikes lightning when a mob is hit with a trident if conditions are
|
|
stormy</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="MULTISHOT">
|
|
<h3>MULTISHOT</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">MULTISHOT</span></div>
|
|
<div class="block">Shoot multiple arrows from crossbows</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="QUICK_CHARGE">
|
|
<h3>QUICK_CHARGE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">QUICK_CHARGE</span></div>
|
|
<div class="block">Charges crossbows quickly</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="PIERCING">
|
|
<h3>PIERCING</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">PIERCING</span></div>
|
|
<div class="block">Crossbow projectiles pierce entities</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="MENDING">
|
|
<h3>MENDING</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">MENDING</span></div>
|
|
<div class="block">Allows mending the item using experience orbs</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="VANISHING_CURSE">
|
|
<h3>VANISHING_CURSE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">VANISHING_CURSE</span></div>
|
|
<div class="block">Item disappears instead of dropping</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="SOUL_SPEED">
|
|
<h3>SOUL_SPEED</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">SOUL_SPEED</span></div>
|
|
<div class="block">Walk quicker on soul blocks</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>(org.bukkit.NamespacedKey)">
|
|
<h3>Enchantment</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Enchantment</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="../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a> key)</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="getKey()">
|
|
<h3>getKey</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> <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="../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a></span> <span class="element-name">getKey</span>()</div>
|
|
<div class="block"><span class="descfrm-type-label">Description copied from interface: <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> in interface <code><a href="../Keyed.html" title="interface in org.bukkit">Keyed</a></code></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this object's key</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>
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="modifiers">public abstract</span> <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> <span class="element-name">getName</span>()</div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">enchantments are badly named, use <a href="#getKey()"><code>getKey()</code></a>.</div>
|
|
</div>
|
|
<div class="block">Gets the unique name of this enchantment</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Unique name</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getMaxLevel()">
|
|
<h3>getMaxLevel</h3>
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name">getMaxLevel</span>()</div>
|
|
<div class="block">Gets the maximum level that this Enchantment may become.</div>
|
|
<dl class="notes">
|
|
<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 abstract</span> <span class="return-type">int</span> <span class="element-name">getStartLevel</span>()</div>
|
|
<div class="block">Gets the level that this Enchantment should start at</div>
|
|
<dl class="notes">
|
|
<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 abstract</span> <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> <span class="element-name">getItemTarget</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>Returns:</dt>
|
|
<dd>Target type of the Enchantment</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isTreasure()">
|
|
<h3>isTreasure</h3>
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">isTreasure</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>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 abstract</span> <span class="return-type">boolean</span> <span class="element-name">isCursed</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>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 abstract</span> <span class="return-type">boolean</span> <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> other)</span></div>
|
|
<div class="block">Check if this enchantment conflicts with another enchantment.</div>
|
|
<dl class="notes">
|
|
<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="canEnchantItem(org.bukkit.inventory.ItemStack)">
|
|
<h3>canEnchantItem</h3>
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <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> item)</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>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="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 abstract</span> <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> <span class="element-name">displayName</span><wbr><span class="parameters">(int level)</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="#getStartLevel()"><code>getStartLevel()</code></a> or greater than the <a href="#getMaxLevel()"><code>getMaxLevel()</code></a>,
|
|
the level may not be shown in the numeral format one may otherwise expect.
|
|
</p></div>
|
|
<dl class="notes">
|
|
<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="isTradeable()">
|
|
<h3>isTradeable</h3>
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">isTradeable</span>()</div>
|
|
<div class="block">Checks if this enchantment can be found in villager trades.</div>
|
|
<dl class="notes">
|
|
<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 abstract</span> <span class="return-type">boolean</span> <span class="element-name">isDiscoverable</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>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 abstract</span> <span class="return-type"><a href="../../../io/papermc/paper/enchantments/EnchantmentRarity.html" title="enum class in io.papermc.paper.enchantments">EnchantmentRarity</a></span> <span class="element-name">getRarity</span>()</div>
|
|
<div class="block">Gets the rarity of this enchantment.</div>
|
|
<dl class="notes">
|
|
<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 abstract</span> <span class="return-type">float</span> <span class="element-name">getDamageIncrease</span><wbr><span class="parameters">(int 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> entityCategory)</span></div>
|
|
<div class="block">Gets the damage increase as a result of the level and entity category specified</div>
|
|
<dl class="notes">
|
|
<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 abstract</span> <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><<a href="../inventory/EquipmentSlot.html" title="enum class in org.bukkit.inventory">EquipmentSlot</a>></span> <span class="element-name">getActiveSlots</span>()</div>
|
|
<div class="block">Gets the equipment slots where this enchantment is considered "active".</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the equipment slots</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="equals(java.lang.Object)">
|
|
<h3>equals</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<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> obj)</span></div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><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></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hashCode()">
|
|
<h3>hashCode</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><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></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="toString()">
|
|
<h3>toString</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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> <span class="element-name">toString</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><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></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="registerEnchantment(org.bukkit.enchantments.Enchantment)">
|
|
<h3>registerEnchantment</h3>
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">registerEnchantment</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> enchantment)</span></div>
|
|
<div class="block">Registers an enchantment with the given ID and object.
|
|
<p>
|
|
Generally not to be used from within a plugin.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>enchantment</code> - Enchantment to register</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isAcceptingRegistrations()">
|
|
<h3>isAcceptingRegistrations</h3>
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isAcceptingRegistrations</span>()</div>
|
|
<div class="block">Checks if this is accepting Enchantment registrations.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>True if the server Implementation may add enchantments</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="stopAcceptingRegistrations()">
|
|
<h3>stopAcceptingRegistrations</h3>
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">stopAcceptingRegistrations</span>()</div>
|
|
<div class="block">Stops accepting any enchantment registrations</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getByKey(org.bukkit.NamespacedKey)">
|
|
<h3>getByKey</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Contract.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Contract</a>("null -> null")
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
</span><span class="modifiers">public static</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">getByKey</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a> key)</span></div>
|
|
<div class="block">Gets the Enchantment at the specified key</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>key</code> - key to fetch</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Resulting Enchantment, or null if not found</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getByName(java.lang.String)">
|
|
<h3>getByName</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Contract.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Contract</a>("null -> null")
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
</span><span class="modifiers">public static</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="Enchantment.html" title="class in org.bukkit.enchantments">Enchantment</a></span> <span class="element-name">getByName</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</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> name)</span></div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">enchantments are badly named, use <a href="#getByKey(org.bukkit.NamespacedKey)"><code>getByKey(org.bukkit.NamespacedKey)</code></a>.</div>
|
|
</div>
|
|
<div class="block">Gets the Enchantment at the specified name</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>name</code> - Name to fetch</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Resulting Enchantment, or null if not found</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="values()">
|
|
<h3>values</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 static</span> <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> <span class="element-name">values</span>()</div>
|
|
<div class="block">Gets an array of all the registered <a href="Enchantment.html" title="class in org.bukkit.enchantments"><code>Enchantment</code></a>s</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Array of enchantments</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|