Scissors-Website/public/javadoc/1.17.1/org/bukkit/loot/Lootable.html

251 lines
26 KiB
HTML
Raw Normal View History

2022-07-05 23:33:56 +00:00
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Lootable (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.loot, interface: Lootable">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.bukkit.loot</a></div>
<h1 title="Interface Lootable" class="title">Interface Lootable</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="../entity/AbstractHorse.html" title="interface in org.bukkit.entity">AbstractHorse</a></code>, <code><a href="../entity/AbstractSkeleton.html" title="interface in org.bukkit.entity">AbstractSkeleton</a></code>, <code><a href="../entity/AbstractVillager.html" title="interface in org.bukkit.entity">AbstractVillager</a></code>, <code><a href="../entity/Ageable.html" title="interface in org.bukkit.entity">Ageable</a></code>, <code><a href="../entity/Ambient.html" title="interface in org.bukkit.entity">Ambient</a></code>, <code><a href="../entity/Animals.html" title="interface in org.bukkit.entity">Animals</a></code>, <code><a href="../entity/Axolotl.html" title="interface in org.bukkit.entity">Axolotl</a></code>, <code><a href="../block/Barrel.html" title="interface in org.bukkit.block">Barrel</a></code>, <code><a href="../entity/Bat.html" title="interface in org.bukkit.entity">Bat</a></code>, <code><a href="../entity/Bee.html" title="interface in org.bukkit.entity">Bee</a></code>, <code><a href="../entity/Blaze.html" title="interface in org.bukkit.entity">Blaze</a></code>, <code><a href="../entity/Breedable.html" title="interface in org.bukkit.entity">Breedable</a></code>, <code><a href="../entity/Cat.html" title="interface in org.bukkit.entity">Cat</a></code>, <code><a href="../entity/CaveSpider.html" title="interface in org.bukkit.entity">CaveSpider</a></code>, <code><a href="../block/Chest.html" title="interface in org.bukkit.block">Chest</a></code>, <code><a href="../entity/ChestedHorse.html" title="interface in org.bukkit.entity">ChestedHorse</a></code>, <code><a href="../entity/Chicken.html" title="interface in org.bukkit.entity">Chicken</a></code>, <code><a href="../entity/Cod.html" title="interface in org.bukkit.entity">Cod</a></code>, <code><a href="../entity/Cow.html" title="interface in org.bukkit.entity">Cow</a></code>, <code><a href="../entity/Creature.html" title="interface in org.bukkit.entity">Creature</a></code>, <code><a href="../entity/Creeper.html" title="interface in org.bukkit.entity">Creeper</a></code>, <code><a href="../block/Dispenser.html" title="interface in org.bukkit.block">Dispenser</a></code>, <code><a href="../entity/Dolphin.html" title="interface in org.bukkit.entity">Dolphin</a></code>, <code><a href="../entity/Donkey.html" title="interface in org.bukkit.entity">Donkey</a></code>, <code><a href="../block/Dropper.html" title="interface in org.bukkit.block">Dropper</a></code>, <code><a href="../entity/Drowned.html" title="interface in org.bukkit.entity">Drowned</a></code>, <code><a href="../entity/ElderGuardian.html" title="interface in org.bukkit.entity">ElderGuardian</a></code>, <code><a href="../entity/EnderDragon.html" title="interface in org.bukkit.entity">EnderDragon</a></code>, <code><a href="../entity/Enderman.html" title="interface in org.bukkit.entity">Enderman</a></code>, <code><a href="../entity/Endermite.html" title="interface in org.bukkit.entity">Endermite</a></code>, <code><a href="../entity/Evoker.html" title="interface in org.bukkit.entity">Evoker</a></code>, <code><a href="../entity/Fish.html" title="interface in org.bukkit.entity">Fish</a></code>, <code><a href="../entity/Flying.html" title="interface in org.bukkit.entity">Flying</a></code>, <code><a href="../entity/Fox.html" title="interface in org.bukkit.entity">Fox</a></code>, <code><a href="../entity/Ghast.html" title="interface in org.bukkit.entity">Ghast</a></code>, <code><a href="../entity/Giant.html" title="interface in org.bukkit.entity">Giant</a></code>, <code><a href="../entity/GlowSquid.html" title="interface in org.bukkit.entity">GlowSquid</a></code>, <code><a href="../entity/Goat.html" title="interface in org.bukkit.entity">Goat</a></code>, <code><a href="../entity/Golem.html" title="interface in org.bukkit.entity">Golem</a></code>, <code><a href="../entity/Guardian.html" title="interface in org.bukkit.entity">Guardian</a></code>, <code><a href="../entity/Hoglin.html" title="interface in org.bukkit.entity">Hoglin</a></code>, <code><a href="../block/Hopper.html" title="interface in org.bukk
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Lootable</span></div>
<div class="block">Represents a <a href="../block/Container.html" title="interface in org.bukkit.block"><code>Container</code></a> or a
<a href="../entity/Mob.html" title="interface in org.bukkit.entity"><code>Mob</code></a> that can have a loot table.
<br>
Container loot will only generate upon opening, and only when the container
is <i>first</i> opened.
<br>
Entities will only generate loot upon death.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-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-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab5"><code>default void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#clearLootTable()" class="member-name-link">clearLootTable</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Clears the associated Loot Table to this object</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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="LootTable.html" title="interface in org.bukkit.loot">LootTable</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLootTable()" class="member-name-link">getLootTable</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 Loot Table attached to this block or entity.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSeed()" class="member-name-link">getSeed</a>()</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 Loot Table's seed.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#hasLootTable()" class="member-name-link">hasLootTable</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Returns whether or not this object has a Loot Table</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLootTable(org.bukkit.loot.LootTable)" class="member-name-link">setLootTable</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="LootTable.html" title="interface in org.bukkit.loot">LootTable</a>&nbsp;table)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Set the loot table for a container or entity.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#setLootTable(org.bukkit.loot.LootTable,long)" class="member-name-link">setLootTable</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="LootTable.html" title="interface in org.bukkit.loot">LootTable</a>&nbsp;table,
long&nbsp;seed)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Set the loot table and seed for a container or entity at the same time.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setSeed(long)" class="member-name-link">setSeed</a><wbr>(long&nbsp;seed)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Set the seed used when this Loot Table generates loot.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="setLootTable(org.bukkit.loot.LootTable)">
<h3>setLootTable</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setLootTable</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="LootTable.html" title="interface in org.bukkit.loot">LootTable</a>&nbsp;table)</span></div>
<div class="block">Set the loot table for a container or entity.
<br>
To remove a loot table use null. Do not use <a href="LootTables.html#EMPTY"><code>LootTables.EMPTY</code></a> to
clear a LootTable.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>table</code> - the Loot Table this <a href="../block/Container.html" title="interface in org.bukkit.block"><code>Container</code></a> or
<a href="../entity/Mob.html" title="interface in org.bukkit.entity"><code>Mob</code></a> will have.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLootTable()">
<h3>getLootTable</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="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="LootTable.html" title="interface in org.bukkit.loot">LootTable</a></span>&nbsp;<span class="element-name">getLootTable</span>()</div>
<div class="block">Gets the Loot Table attached to this block or entity.
<br>
If an block/entity does not have a loot table, this will return null, NOT
an empty loot table.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the Loot Table attached to this block or entity.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setLootTable(org.bukkit.loot.LootTable,long)">
<h3>setLootTable</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setLootTable</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="LootTable.html" title="interface in org.bukkit.loot">LootTable</a>&nbsp;table,
long&nbsp;seed)</span></div>
<div class="block">Set the loot table and seed for a container or entity at the same time.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>table</code> - the Loot Table this <a href="../block/Container.html" title="interface in org.bukkit.block"><code>Container</code></a> or <a href="../entity/Mob.html" title="interface in org.bukkit.entity"><code>Mob</code></a> will have.</dd>
<dd><code>seed</code> - the seed to used to generate loot. Default is 0.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hasLootTable()">
<h3>hasLootTable</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">hasLootTable</span>()</div>
<div class="block">Returns whether or not this object has a Loot Table</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Has a loot table</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="clearLootTable()">
<h3>clearLootTable</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">clearLootTable</span>()</div>
<div class="block">Clears the associated Loot Table to this object</div>
</section>
</li>
<li>
<section class="detail" id="setSeed(long)">
<h3>setSeed</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setSeed</span><wbr><span class="parameters">(long&nbsp;seed)</span></div>
<div class="block">Set the seed used when this Loot Table generates loot.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>seed</code> - the seed to used to generate loot. Default is 0.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSeed()">
<h3>getSeed</h3>
<div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getSeed</span>()</div>
<div class="block">Get the Loot Table's seed.
<br>
The seed is used when generating loot.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the seed</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>