|
| 1 | +<!DOCTYPE HTML> |
| 2 | +<html lang="en"> |
| 3 | +<head> |
| 4 | +<!-- Generated by javadoc (21) --> |
| 5 | +<title>ItemAction.ApplyEffects (SpongeAPI 16.0.0-SNAPSHOT API)</title> |
| 6 | +<meta name="viewport" content="width=device-width, initial-scale=1"> |
| 7 | +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 8 | +<meta name="description" content="declaration: package: org.spongepowered.api.data.type, interface: ItemAction, interface: ApplyEffects"> |
| 9 | +<meta name="generator" content="javadoc/ClassWriterImpl"> |
| 10 | +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| 11 | +<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| 12 | +<script type="text/javascript" src="../../../../../script.js"></script> |
| 13 | +<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> |
| 14 | +<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| 15 | +</head> |
| 16 | +<body class="class-declaration-page"> |
| 17 | +<script type="text/javascript">var pathtoroot = "../../../../../"; |
| 18 | +loadScripts(document, 'script');</script> |
| 19 | +<noscript> |
| 20 | +<div>JavaScript is disabled on your browser.</div> |
| 21 | +</noscript> |
| 22 | +<div class="flex-box"> |
| 23 | +<header role="banner" class="flex-header"> |
| 24 | +<nav role="navigation"> |
| 25 | +<!-- ========= START OF TOP NAVBAR ======= --> |
| 26 | +<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| 27 | +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| 28 | +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| 29 | +<li><a href="../../../../../index.html">Overview</a></li> |
| 30 | +<li><a href="package-summary.html">Package</a></li> |
| 31 | +<li class="nav-bar-cell1-rev">Class</li> |
| 32 | +<li><a href="package-tree.html">Tree</a></li> |
| 33 | +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| 34 | +<li><a href="../../../../../index-all.html">Index</a></li> |
| 35 | +<li><a href="../../../../../help-doc.html#class">Help</a></li> |
| 36 | +</ul> |
| 37 | +<ul class="sub-nav-list-small"> |
| 38 | +<li> |
| 39 | +<p>Summary:</p> |
| 40 | +<ul> |
| 41 | +<li><a href="#nested-class-summary">Nested</a></li> |
| 42 | +<li>Field</li> |
| 43 | +<li>Constr</li> |
| 44 | +<li><a href="#method-summary">Method</a></li> |
| 45 | +</ul> |
| 46 | +</li> |
| 47 | +<li> |
| 48 | +<p>Detail:</p> |
| 49 | +<ul> |
| 50 | +<li>Field</li> |
| 51 | +<li>Constr</li> |
| 52 | +<li><a href="#method-detail">Method</a></li> |
| 53 | +</ul> |
| 54 | +</li> |
| 55 | +</ul> |
| 56 | +</div> |
| 57 | +<div class="sub-nav"> |
| 58 | +<div id="navbar-sub-list"> |
| 59 | +<ul class="sub-nav-list"> |
| 60 | +<li>Summary: </li> |
| 61 | +<li><a href="#nested-class-summary">Nested</a> | </li> |
| 62 | +<li>Field | </li> |
| 63 | +<li>Constr | </li> |
| 64 | +<li><a href="#method-summary">Method</a></li> |
| 65 | +</ul> |
| 66 | +<ul class="sub-nav-list"> |
| 67 | +<li>Detail: </li> |
| 68 | +<li>Field | </li> |
| 69 | +<li>Constr | </li> |
| 70 | +<li><a href="#method-detail">Method</a></li> |
| 71 | +</ul> |
| 72 | +</div> |
| 73 | +<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a> |
| 74 | +<input type="text" id="search-input" disabled placeholder="Search"> |
| 75 | +<input type="reset" id="reset-button" disabled value="reset"> |
| 76 | +</div> |
| 77 | +</div> |
| 78 | +<!-- ========= END OF TOP NAVBAR ========= --> |
| 79 | +<span class="skip-nav" id="skip-navbar-top"></span></nav> |
| 80 | +</header> |
| 81 | +<div class="flex-content"> |
| 82 | +<main role="main"> |
| 83 | +<!-- ======== START OF CLASS DATA ======== --> |
| 84 | +<div class="header"> |
| 85 | +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.spongepowered.api.data.type</a></div> |
| 86 | +<h1 title="Interface ItemAction.ApplyEffects" class="title">Interface ItemAction.ApplyEffects</h1> |
| 87 | +</div> |
| 88 | +<section class="class-description" id="class-description"> |
| 89 | +<dl class="notes"> |
| 90 | +<dt>All Superinterfaces:</dt> |
| 91 | +<dd><code><a href="ItemAction.html" title="interface in org.spongepowered.api.data.type">ItemAction</a></code></dd> |
| 92 | +</dl> |
| 93 | +<dl class="notes"> |
| 94 | +<dt>Enclosing interface:</dt> |
| 95 | +<dd><code><a href="ItemAction.html" title="interface in org.spongepowered.api.data.type">ItemAction</a></code></dd> |
| 96 | +</dl> |
| 97 | +<hr> |
| 98 | +<div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">ItemAction.ApplyEffects</span><span class="extends-implements"> |
| 99 | +extends <a href="ItemAction.html" title="interface in org.spongepowered.api.data.type">ItemAction</a></span></div> |
| 100 | +<div class="block">Applies <a href="../../effect/potion/PotionEffect.html" title="interface in org.spongepowered.api.effect.potion"><code>PotionEffect</code></a>s with chance.</div> |
| 101 | +</section> |
| 102 | +<section class="summary"> |
| 103 | +<ul class="summary-list"> |
| 104 | +<!-- ======== NESTED CLASS SUMMARY ======== --> |
| 105 | +<li> |
| 106 | +<section class="nested-class-summary" id="nested-class-summary"> |
| 107 | +<h2>Nested Class Summary</h2> |
| 108 | +<div class="inherited-list"> |
| 109 | +<h2 id="nested-classes-inherited-from-class-org.spongepowered.api.data.type.ItemAction">Nested classes/interfaces inherited from interface org.spongepowered.api.data.type.<a href="ItemAction.html" title="interface in org.spongepowered.api.data.type">ItemAction</a></h2> |
| 110 | +<code><a href="ItemAction.ApplyEffects.html" title="interface in org.spongepowered.api.data.type">ItemAction.ApplyEffects</a>, <a href="ItemAction.ClearEffects.html" title="interface in org.spongepowered.api.data.type">ItemAction.ClearEffects</a>, <a href="ItemAction.Factory.html" title="interface in org.spongepowered.api.data.type">ItemAction.Factory</a>, <a href="ItemAction.PlaySound.html" title="interface in org.spongepowered.api.data.type">ItemAction.PlaySound</a>, <a href="ItemAction.RemoveEffects.html" title="interface in org.spongepowered.api.data.type">ItemAction.RemoveEffects</a>, <a href="ItemAction.TeleportRandomly.html" title="interface in org.spongepowered.api.data.type">ItemAction.TeleportRandomly</a></code></div> |
| 111 | +</section> |
| 112 | +</li> |
| 113 | +<!-- ========== METHOD SUMMARY =========== --> |
| 114 | +<li> |
| 115 | +<section class="method-summary" id="method-summary"> |
| 116 | +<h2>Method Summary</h2> |
| 117 | +<div id="method-summary-table"> |
| 118 | +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-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></div> |
| 119 | +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> |
| 120 | +<div class="summary-table three-column-summary"> |
| 121 | +<div class="table-header col-first">Modifier and Type</div> |
| 122 | +<div class="table-header col-second">Method</div> |
| 123 | +<div class="table-header col-last">Description</div> |
| 124 | +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> |
| 125 | +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#chance()" class="member-name-link">chance</a>()</code></div> |
| 126 | +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| 127 | +<div class="block">Returns the probability for effects to be applied.</div> |
| 128 | +</div> |
| 129 | +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="../../effect/potion/PotionEffect.html" title="interface in org.spongepowered.api.effect.potion">PotionEffect</a>></code></div> |
| 130 | +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#effects()" class="member-name-link">effects</a>()</code></div> |
| 131 | +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| 132 | +<div class="block">Returns <a href="../../effect/potion/PotionEffect.html" title="interface in org.spongepowered.api.effect.potion"><code>PotionEffect</code></a>s that will be applied.</div> |
| 133 | +</div> |
| 134 | +</div> |
| 135 | +</div> |
| 136 | +</div> |
| 137 | +<div class="inherited-list"> |
| 138 | +<h3 id="methods-inherited-from-class-org.spongepowered.api.data.type.ItemAction">Methods inherited from interface org.spongepowered.api.data.type.<a href="ItemAction.html" title="interface in org.spongepowered.api.data.type">ItemAction</a></h3> |
| 139 | +<code><a href="ItemAction.html#apply(org.spongepowered.api.entity.living.Living)">apply</a>, <a href="ItemAction.html#apply(org.spongepowered.api.entity.living.Living,org.spongepowered.api.item.inventory.ItemStackLike)">apply</a>, <a href="ItemAction.html#type()">type</a></code></div> |
| 140 | +</section> |
| 141 | +</li> |
| 142 | +</ul> |
| 143 | +</section> |
| 144 | +<section class="details"> |
| 145 | +<ul class="details-list"> |
| 146 | +<!-- ============ METHOD DETAIL ========== --> |
| 147 | +<li> |
| 148 | +<section class="method-details" id="method-detail"> |
| 149 | +<h2>Method Details</h2> |
| 150 | +<ul class="member-list"> |
| 151 | +<li> |
| 152 | +<section class="detail" id="chance()"> |
| 153 | +<h3>chance</h3> |
| 154 | +<div class="member-signature"><span class="return-type">double</span> <span class="element-name">chance</span>()</div> |
| 155 | +<div class="block">Returns the probability for effects to be applied.</div> |
| 156 | +<dl class="notes"> |
| 157 | +<dt>Returns:</dt> |
| 158 | +<dd>The probability for effects to be applied</dd> |
| 159 | +</dl> |
| 160 | +</section> |
| 161 | +</li> |
| 162 | +<li> |
| 163 | +<section class="detail" id="effects()"> |
| 164 | +<h3>effects</h3> |
| 165 | +<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../effect/potion/PotionEffect.html" title="interface in org.spongepowered.api.effect.potion">PotionEffect</a>></span> <span class="element-name">effects</span>()</div> |
| 166 | +<div class="block">Returns <a href="../../effect/potion/PotionEffect.html" title="interface in org.spongepowered.api.effect.potion"><code>PotionEffect</code></a>s that will be applied.</div> |
| 167 | +<dl class="notes"> |
| 168 | +<dt>Returns:</dt> |
| 169 | +<dd><a href="../../effect/potion/PotionEffect.html" title="interface in org.spongepowered.api.effect.potion"><code>PotionEffect</code></a>s that will be applied</dd> |
| 170 | +</dl> |
| 171 | +</section> |
| 172 | +</li> |
| 173 | +</ul> |
| 174 | +</section> |
| 175 | +</li> |
| 176 | +</ul> |
| 177 | +</section> |
| 178 | +<!-- ========= END OF CLASS DATA ========= --> |
| 179 | +</main> |
| 180 | +</div> |
| 181 | +</div> |
| 182 | +</body> |
| 183 | +</html> |
![spongie-jd[bot]](https://avatars.githubusercontent.com/in/881989?v=4&size=40){kind=avatar}
0 commit comments