mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2024-07-03 07:30:02 +00:00
822 lines
59 KiB
HTML
822 lines
59 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>PotionEffectType (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.potion, class: PotionEffectType">
|
|
<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.potion</a></div>
|
|
<h1 title="Class PotionEffectType" class="title">Class PotionEffectType</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.potion.PotionEffectType</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><code><a href="PotionEffectTypeWrapper.html" title="class in org.bukkit.potion">PotionEffectTypeWrapper</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">PotionEffectType</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></span></div>
|
|
<div class="block">Represents a type of potion and its effect on an entity.</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="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#ABSORPTION" class="member-name-link">ABSORPTION</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Increases the maximum health of an entity with health that cannot be
|
|
regenerated, but is refilled every 30 seconds.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#BAD_OMEN" class="member-name-link">BAD_OMEN</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">oof.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#BLINDNESS" class="member-name-link">BLINDNESS</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Blinds an entity.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#CONDUIT_POWER" class="member-name-link">CONDUIT_POWER</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Effects granted by a nearby conduit.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#CONFUSION" class="member-name-link">CONFUSION</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Warps vision on the client.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#DAMAGE_RESISTANCE" class="member-name-link">DAMAGE_RESISTANCE</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Decreases damage dealt to an entity.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#DOLPHINS_GRACE" class="member-name-link">DOLPHINS_GRACE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Squee'ek uh'k kk'kkkk squeek eee'eek.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#FAST_DIGGING" class="member-name-link">FAST_DIGGING</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Increases dig speed.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#FIRE_RESISTANCE" class="member-name-link">FIRE_RESISTANCE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Stops fire damage.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#GLOWING" class="member-name-link">GLOWING</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Outlines the entity so that it can be seen from afar.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#HARM" class="member-name-link">HARM</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Hurts an entity.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#HEAL" class="member-name-link">HEAL</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Heals an entity.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#HEALTH_BOOST" class="member-name-link">HEALTH_BOOST</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Increases the maximum health of an entity.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#HERO_OF_THE_VILLAGE" class="member-name-link">HERO_OF_THE_VILLAGE</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">\o/.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#HUNGER" class="member-name-link">HUNGER</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Increases hunger.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#INCREASE_DAMAGE" class="member-name-link">INCREASE_DAMAGE</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Increases damage dealt.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#INVISIBILITY" class="member-name-link">INVISIBILITY</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Grants invisibility.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#JUMP" class="member-name-link">JUMP</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Increases jump height.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#LEVITATION" class="member-name-link">LEVITATION</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Causes the entity to float into the air.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</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">Loot table luck.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#NIGHT_VISION" class="member-name-link">NIGHT_VISION</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Allows an entity to see in the dark.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#POISON" class="member-name-link">POISON</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Deals damage to an entity over time.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#REGENERATION" class="member-name-link">REGENERATION</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Regenerates health.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#SATURATION" class="member-name-link">SATURATION</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Increases the food level of an entity each tick.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#SLOW" class="member-name-link">SLOW</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Decreases movement speed.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#SLOW_DIGGING" class="member-name-link">SLOW_DIGGING</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Decreases dig speed.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#SLOW_FALLING" class="member-name-link">SLOW_FALLING</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Slows entity fall rate.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#SPEED" class="member-name-link">SPEED</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Increases movement speed.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#UNLUCK" class="member-name-link">UNLUCK</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Loot table unluck.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#WATER_BREATHING" class="member-name-link">WATER_BREATHING</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Allows breathing underwater.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#WEAKNESS" class="member-name-link">WEAKNESS</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Decreases damage dealt by an entity.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static final <a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#WITHER" class="member-name-link">WITHER</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Deals damage to an entity over time and gives the health to the
|
|
shooter.</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 three-column-summary">
|
|
<div class="table-header col-first">Modifier</div>
|
|
<div class="table-header col-second">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>protected </code></div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">PotionEffectType</a><wbr>(int id)</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-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="PotionEffect.html" title="class in org.bukkit.potion">PotionEffect</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createEffect(int,int)" class="member-name-link">createEffect</a><wbr>(int duration,
|
|
int amplifier)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Creates a PotionEffect from this PotionEffectType, applying duration
|
|
modifiers and checks.</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-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="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</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="#getById(int)" class="member-name-link">getById</a><wbr>(int id)</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">Magic value</div>
|
|
</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="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><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/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> name)</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 effect type specified by the given name.</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="../Color.html" title="class in org.bukkit">Color</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getColor()" class="member-name-link">getColor</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Returns the color of this effect type.</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 double</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="#getDurationModifier()" class="member-name-link">getDurationModifier</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">unused, always 1.0</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getId()" class="member-name-link">getId</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Magic value</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first odd-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="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"><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">
|
|
<div class="block">Returns the name of this effect type.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>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-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="#isInstant()" class="member-name-link">isInstant</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Returns whether the effect of this type happens once, immediately.</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="#registerPotionEffectType(org.bukkit.potion.PotionEffectType)" class="member-name-link">registerPotionEffectType</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="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a> type)</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 effect type with the given 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 effect type 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="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a>[]</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-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">Returns an array of all the registered <a href="PotionEffectType.html" title="class in org.bukkit.potion"><code>PotionEffectType</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>
|
|
</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="SPEED">
|
|
<h3>SPEED</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">SPEED</span></div>
|
|
<div class="block">Increases movement speed.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="SLOW">
|
|
<h3>SLOW</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">SLOW</span></div>
|
|
<div class="block">Decreases movement speed.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="FAST_DIGGING">
|
|
<h3>FAST_DIGGING</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">FAST_DIGGING</span></div>
|
|
<div class="block">Increases dig speed.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="SLOW_DIGGING">
|
|
<h3>SLOW_DIGGING</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">SLOW_DIGGING</span></div>
|
|
<div class="block">Decreases dig speed.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="INCREASE_DAMAGE">
|
|
<h3>INCREASE_DAMAGE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">INCREASE_DAMAGE</span></div>
|
|
<div class="block">Increases damage dealt.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="HEAL">
|
|
<h3>HEAL</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">HEAL</span></div>
|
|
<div class="block">Heals an entity.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="HARM">
|
|
<h3>HARM</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">HARM</span></div>
|
|
<div class="block">Hurts an entity.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="JUMP">
|
|
<h3>JUMP</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">JUMP</span></div>
|
|
<div class="block">Increases jump height.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="CONFUSION">
|
|
<h3>CONFUSION</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">CONFUSION</span></div>
|
|
<div class="block">Warps vision on the client.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="REGENERATION">
|
|
<h3>REGENERATION</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">REGENERATION</span></div>
|
|
<div class="block">Regenerates health.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DAMAGE_RESISTANCE">
|
|
<h3>DAMAGE_RESISTANCE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">DAMAGE_RESISTANCE</span></div>
|
|
<div class="block">Decreases damage dealt to an entity.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="FIRE_RESISTANCE">
|
|
<h3>FIRE_RESISTANCE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">FIRE_RESISTANCE</span></div>
|
|
<div class="block">Stops fire damage.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="WATER_BREATHING">
|
|
<h3>WATER_BREATHING</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">WATER_BREATHING</span></div>
|
|
<div class="block">Allows breathing underwater.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="INVISIBILITY">
|
|
<h3>INVISIBILITY</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">INVISIBILITY</span></div>
|
|
<div class="block">Grants invisibility.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="BLINDNESS">
|
|
<h3>BLINDNESS</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">BLINDNESS</span></div>
|
|
<div class="block">Blinds an entity.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="NIGHT_VISION">
|
|
<h3>NIGHT_VISION</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">NIGHT_VISION</span></div>
|
|
<div class="block">Allows an entity to see in the dark.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="HUNGER">
|
|
<h3>HUNGER</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">HUNGER</span></div>
|
|
<div class="block">Increases hunger.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="WEAKNESS">
|
|
<h3>WEAKNESS</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">WEAKNESS</span></div>
|
|
<div class="block">Decreases damage dealt by an entity.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="POISON">
|
|
<h3>POISON</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">POISON</span></div>
|
|
<div class="block">Deals damage to an entity over time.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="WITHER">
|
|
<h3>WITHER</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">WITHER</span></div>
|
|
<div class="block">Deals damage to an entity over time and gives the health to the
|
|
shooter.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="HEALTH_BOOST">
|
|
<h3>HEALTH_BOOST</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">HEALTH_BOOST</span></div>
|
|
<div class="block">Increases the maximum health of an entity.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="ABSORPTION">
|
|
<h3>ABSORPTION</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">ABSORPTION</span></div>
|
|
<div class="block">Increases the maximum health of an entity with health that cannot be
|
|
regenerated, but is refilled every 30 seconds.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="SATURATION">
|
|
<h3>SATURATION</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">SATURATION</span></div>
|
|
<div class="block">Increases the food level of an entity each tick.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="GLOWING">
|
|
<h3>GLOWING</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">GLOWING</span></div>
|
|
<div class="block">Outlines the entity so that it can be seen from afar.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="LEVITATION">
|
|
<h3>LEVITATION</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">LEVITATION</span></div>
|
|
<div class="block">Causes the entity to float into the air.</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="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">LUCK</span></div>
|
|
<div class="block">Loot table luck.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="UNLUCK">
|
|
<h3>UNLUCK</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">UNLUCK</span></div>
|
|
<div class="block">Loot table unluck.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="SLOW_FALLING">
|
|
<h3>SLOW_FALLING</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">SLOW_FALLING</span></div>
|
|
<div class="block">Slows entity fall rate.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="CONDUIT_POWER">
|
|
<h3>CONDUIT_POWER</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">CONDUIT_POWER</span></div>
|
|
<div class="block">Effects granted by a nearby conduit. Includes enhanced underwater abilities.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DOLPHINS_GRACE">
|
|
<h3>DOLPHINS_GRACE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">DOLPHINS_GRACE</span></div>
|
|
<div class="block">Squee'ek uh'k kk'kkkk squeek eee'eek.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="BAD_OMEN">
|
|
<h3>BAD_OMEN</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">BAD_OMEN</span></div>
|
|
<div class="block">oof.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="HERO_OF_THE_VILLAGE">
|
|
<h3>HERO_OF_THE_VILLAGE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">HERO_OF_THE_VILLAGE</span></div>
|
|
<div class="block">\o/.</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>(int)">
|
|
<h3>PotionEffectType</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">PotionEffectType</span><wbr><span class="parameters">(int id)</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="createEffect(int,int)">
|
|
<h3>createEffect</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="PotionEffect.html" title="class in org.bukkit.potion">PotionEffect</a></span> <span class="element-name">createEffect</span><wbr><span class="parameters">(int duration,
|
|
int amplifier)</span></div>
|
|
<div class="block">Creates a PotionEffect from this PotionEffectType, applying duration
|
|
modifiers and checks.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>duration</code> - time in ticks</dd>
|
|
<dd><code>amplifier</code> - the effect's amplifier</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>a resulting potion effect</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list-long">
|
|
<li><a href="PotionBrewer.html#createEffect(org.bukkit.potion.PotionEffectType,int,int)"><code>PotionBrewer.createEffect(PotionEffectType, int, int)</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDurationModifier()">
|
|
<h3>getDurationModifier</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>
|
|
</span><span class="modifiers">public abstract</span> <span class="return-type">double</span> <span class="element-name">getDurationModifier</span>()</div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">unused, always 1.0</div>
|
|
</div>
|
|
<div class="block">Returns the duration modifier applied to effects of this type.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>duration modifier</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getId()">
|
|
<h3>getId</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>
|
|
</span><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getId</span>()</div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Magic value</div>
|
|
</div>
|
|
<div class="block">Returns the unique ID of this type.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Unique ID</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 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="block">Returns the name of this effect type.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The name of this effect type</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isInstant()">
|
|
<h3>isInstant</h3>
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">isInstant</span>()</div>
|
|
<div class="block">Returns whether the effect of this type happens once, immediately.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>whether this type is normally instant</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getColor()">
|
|
<h3>getColor</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/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="../Color.html" title="class in org.bukkit">Color</a></span> <span class="element-name">getColor</span>()</div>
|
|
<div class="block">Returns the color of this effect type.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the color</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="getById(int)">
|
|
<h3>getById</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/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="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a></span> <span class="element-name">getById</span><wbr><span class="parameters">(int id)</span></div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Magic value</div>
|
|
</div>
|
|
<div class="block">Gets the effect type specified by the unique id.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>id</code> - Unique ID to fetch</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Resulting type, 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://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="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</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/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> name)</span></div>
|
|
<div class="block">Gets the effect type specified by the given name.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>name</code> - Name of PotionEffectType to fetch</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Resulting PotionEffectType, or null if not found.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="registerPotionEffectType(org.bukkit.potion.PotionEffectType)">
|
|
<h3>registerPotionEffectType</h3>
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">registerPotionEffectType</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="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a> type)</span></div>
|
|
<div class="block">Registers an effect type with the given object.
|
|
<p>
|
|
Generally not to be used from within a plugin.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>type</code> - PotionType to register</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 effect type registrations.</div>
|
|
</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="PotionEffectType.html" title="class in org.bukkit.potion">PotionEffectType</a>[]</span> <span class="element-name">values</span>()</div>
|
|
<div class="block">Returns an array of all the registered <a href="PotionEffectType.html" title="class in org.bukkit.potion"><code>PotionEffectType</code></a>s.
|
|
This array is not necessarily in any particular order.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Array of types.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|