AtlasMediaGroup/Scissors-Website
1
0
Fork 0
mirror of https://github.com/AtlasMediaGroup/Scissors-Website.git synced 2024-11-19 14:55:00 +00:00
Code Issues Packages Projects Releases Wiki Activity
5455fbe8b9
Scissors-Website/public/javadoc/1.17.1/org/bukkit/material/Mushroom.html

459 lines
31 KiB
HTML
Raw Normal View History

Add Javadocs
2022-07-05 23:33:56 +00:00
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Mushroom (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.material, class: Mushroom">
<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><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.bukkit.material</a></div>
<h1 title="Class Mushroom" class="title">Class Mushroom</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="MaterialData.html" title="class in org.bukkit.material">org.bukkit.material.MaterialData</a>
<div class="inheritance">org.bukkit.material.Mushroom</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code></dd>
</dl>
<hr>
<div class="type-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 class </span><span class="element-name type-name-label">Mushroom</span>
<span class="extends-implements">extends <a href="MaterialData.html" title="class in org.bukkit.material">MaterialData</a></span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">all usage of MaterialData is deprecated and subject to removal.
Use <a href="../block/data/BlockData.html" title="interface in org.bukkit.block.data"><code>BlockData</code></a>.</div>
</div>
<div class="block">Represents a huge mushroom block with certain combinations of faces set to
cap, pores or stem.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../Material.html#LEGACY_HUGE_MUSHROOM_1"><code>Material.LEGACY_HUGE_MUSHROOM_1</code></a></li>
<li><a href="../Material.html#LEGACY_HUGE_MUSHROOM_2"><code>Material.LEGACY_HUGE_MUSHROOM_2</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.bukkit.Material)" class="member-name-link">Mushroom</a><wbr>(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;shroom)</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs a brown/red mushroom block with all sides set to pores.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.bukkit.Material,byte)" class="member-name-link">Mushroom</a><wbr>(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;shroom,
byte&nbsp;data)</code></div>
<div class="col-last odd-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Magic value</div>
</div>
</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.bukkit.Material,org.bukkit.block.BlockFace)" class="member-name-link">Mushroom</a><wbr>(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;shroom,
<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;capFace)</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs a brown/red mushroom cap block with the specified face or
faces set to cap texture.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.bukkit.Material,org.bukkit.material.types.MushroomBlockTexture)" class="member-name-link">Mushroom</a><wbr>(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;shroom,
<a href="types/MushroomBlockTexture.html" title="enum class in org.bukkit.material.types">MushroomBlockTexture</a>&nbsp;texture)</code></div>
<div class="col-last odd-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs a brown/red mushroom block with the specified textures.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><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 method-summary-table-tab6"><code><a href="Mushroom.html" title="class in org.bukkit.material">Mushroom</a></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="#clone()" class="member-name-link">clone</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>
&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="types/MushroomBlockTexture.html" title="enum class in org.bukkit.material.types">MushroomBlockTexture</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getBlockTexture()" class="member-name-link">getBlockTexture</a>()</code></div>
<div class="col-last odd-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>
<div class="block">Gets the mushroom texture of this block.</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><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&gt;</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="#getPaintedFaces()" class="member-name-link">getPaintedFaces</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>
&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isFacePainted(org.bukkit.block.BlockFace)" class="member-name-link">isFacePainted</a><wbr>(<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face)</code></div>
<div class="col-last odd-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>
<div class="block">Checks whether a face of the block is painted with cap texture.</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>boolean</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="#isStem()" class="member-name-link">isStem</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>
&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setBlockTexture(org.bukkit.material.types.MushroomBlockTexture)" class="member-name-link">setBlockTexture</a><wbr>(<a href="types/MushroomBlockTexture.html" title="enum class in org.bukkit.material.types">MushroomBlockTexture</a>&nbsp;texture)</code></div>
<div class="col-last odd-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>
<div class="block">Sets the mushroom texture of this block.</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>void</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="#setFacePainted(org.bukkit.block.BlockFace,boolean)" class="member-name-link">setFacePainted</a><wbr>(<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face,
boolean&nbsp;painted)</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">Use MushroomBlockType cap options</div>
</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setStem()" class="member-name-link">setStem</a>()</code></div>
<div class="col-last odd-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">Use
<a href="#setBlockTexture(org.bukkit.material.types.MushroomBlockTexture)"><code>setBlockTexture(org.bukkit.material.types.MushroomBlockTexture)</code></a>
with <a href="types/MushroomBlockTexture.html#STEM_SIDES"><code>MushroomBlockTexture.STEM_SIDES</code></a> or
<a href="types/MushroomBlockTexture.html#ALL_STEM"><code>MushroomBlockTexture.ALL_STEM</code></a></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><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 method-summary-table-tab6"><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 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.bukkit.material.MaterialData">Methods inherited from class&nbsp;org.bukkit.material.<a href="MaterialData.html" title="class in org.bukkit.material">MaterialData</a></h3>
<code><a href="MaterialData.html#equals(java.lang.Object)">equals</a>, <a href="MaterialData.html#getData()">getData</a>, <a href="MaterialData.html#getItemType()">getItemType</a>, <a href="MaterialData.html#hashCode()">hashCode</a>, <a href="MaterialData.html#setData(byte)">setData</a>, <a href="MaterialData.html#toItemStack()">toItemStack</a>, <a href="MaterialData.html#toItemStack(int)">toItemStack</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.Material)">
<h3>Mushroom</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Mushroom</span><wbr><span class="parameters">(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;shroom)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs a brown/red mushroom block with all sides set to pores.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>shroom</code> - A brown or red mushroom material type.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../Material.html#LEGACY_HUGE_MUSHROOM_1"><code>Material.LEGACY_HUGE_MUSHROOM_1</code></a></li>
<li><a href="../Material.html#LEGACY_HUGE_MUSHROOM_2"><code>Material.LEGACY_HUGE_MUSHROOM_2</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.Material,org.bukkit.block.BlockFace)">
<h3>Mushroom</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Mushroom</span><wbr><span class="parameters">(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;shroom,
<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;capFace)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs a brown/red mushroom cap block with the specified face or
faces set to cap texture.
Setting any of the four sides will also set the top to cap.
To set two side faces at once use e.g. north-west.
Specify self to set all six faces at once.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>shroom</code> - A brown or red mushroom material type.</dd>
<dd><code>capFace</code> - The face or faces to set to mushroom cap texture.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../Material.html#LEGACY_HUGE_MUSHROOM_1"><code>Material.LEGACY_HUGE_MUSHROOM_1</code></a></li>
<li><a href="../Material.html#LEGACY_HUGE_MUSHROOM_2"><code>Material.LEGACY_HUGE_MUSHROOM_2</code></a></li>
<li><a href="../block/BlockFace.html" title="enum class in org.bukkit.block"><code>BlockFace</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.Material,org.bukkit.material.types.MushroomBlockTexture)">
<h3>Mushroom</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Mushroom</span><wbr><span class="parameters">(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;shroom,
<a href="types/MushroomBlockTexture.html" title="enum class in org.bukkit.material.types">MushroomBlockTexture</a>&nbsp;texture)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs a brown/red mushroom block with the specified textures.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>shroom</code> - A brown or red mushroom material type.</dd>
<dd><code>texture</code> - The textured mushroom faces.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../Material.html#LEGACY_HUGE_MUSHROOM_1"><code>Material.LEGACY_HUGE_MUSHROOM_1</code></a></li>
<li><a href="../Material.html#LEGACY_HUGE_MUSHROOM_2"><code>Material.LEGACY_HUGE_MUSHROOM_2</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.Material,byte)">
<h3>Mushroom</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>&nbsp;<span class="element-name">Mushroom</span><wbr><span class="parameters">(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;shroom,
byte&nbsp;data)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Magic value</div>
</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>shroom</code> - the type</dd>
<dd><code>data</code> - the raw data value</dd>
</dl>
</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="isStem()">
<h3>isStem</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isStem</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Whether this is a mushroom stem.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setStem()">
<h3>setStem</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>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setStem</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use
<a href="#setBlockTexture(org.bukkit.material.types.MushroomBlockTexture)"><code>setBlockTexture(org.bukkit.material.types.MushroomBlockTexture)</code></a>
with <a href="types/MushroomBlockTexture.html#STEM_SIDES"><code>MushroomBlockTexture.STEM_SIDES</code></a> or
<a href="types/MushroomBlockTexture.html#ALL_STEM"><code>MushroomBlockTexture.ALL_STEM</code></a></div>
</div>
<div class="block">Sets this to be a mushroom stem.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="types/MushroomBlockTexture.html#STEM_SIDES"><code>MushroomBlockTexture.STEM_SIDES</code></a></li>
<li><a href="types/MushroomBlockTexture.html#ALL_STEM"><code>MushroomBlockTexture.ALL_STEM</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBlockTexture()">
<h3>getBlockTexture</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="types/MushroomBlockTexture.html" title="enum class in org.bukkit.material.types">MushroomBlockTexture</a></span>&nbsp;<span class="element-name">getBlockTexture</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Gets the mushroom texture of this block.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The mushroom texture of this block</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setBlockTexture(org.bukkit.material.types.MushroomBlockTexture)">
<h3>setBlockTexture</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setBlockTexture</span><wbr><span class="parameters">(<a href="types/MushroomBlockTexture.html" title="enum class in org.bukkit.material.types">MushroomBlockTexture</a>&nbsp;texture)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Sets the mushroom texture of this block.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>texture</code> - The mushroom texture to set</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isFacePainted(org.bukkit.block.BlockFace)">
<h3>isFacePainted</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isFacePainted</span><wbr><span class="parameters">(<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Checks whether a face of the block is painted with cap texture.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>face</code> - The face to check.</dd>
<dt>Returns:</dt>
<dd>True if it is painted.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setFacePainted(org.bukkit.block.BlockFace,boolean)">
<h3>setFacePainted</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>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setFacePainted</span><wbr><span class="parameters">(<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face,
boolean&nbsp;painted)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use MushroomBlockType cap options</div>
</div>
<div class="block">Set a face of the block to be painted or not. Note that due to the
nature of how the data is stored, setting a face painted or not is not
guaranteed to leave the other faces unchanged.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>face</code> - The face to paint or unpaint.</dd>
<dd><code>painted</code> - True if you want to paint it, false if you want the
pores to show.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getPaintedFaces()">
<h3>getPaintedFaces</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&gt;</span>&nbsp;<span class="element-name">getPaintedFaces</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>A set of all faces that are currently painted (an empty set if
it is a stem)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="MaterialData.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="MaterialData.html" title="class in org.bukkit.material">MaterialData</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="clone()">
<h3>clone</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Mushroom.html" title="class in org.bukkit.material">Mushroom</a></span>&nbsp;<span class="element-name">clone</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="MaterialData.html#clone()">clone</a></code>&nbsp;in class&nbsp;<code><a href="MaterialData.html" title="class in org.bukkit.material">MaterialData</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink