AtlasMediaGroup/Scissors-Website
1
0
Fork 0
mirror of https://github.com/AtlasMediaGroup/Scissors-Website.git synced 2025-02-22 19:00:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
Scissors-Website/javadoc/1.19.4/org/bukkit/block/data/BlockData.html

513 lines
50 KiB
HTML
Raw Normal View History

Test
2023-04-02 20:49:18 -05:00
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>BlockData (Scissors-API 1.19.4-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.block.data, interface: BlockData">
<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.6.0.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="class-use/BlockData.html">Use</a></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.block.data</a></div>
<h1 title="Interface BlockData" class="title">Interface BlockData</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</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>
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="Ageable.html" title="interface in org.bukkit.block.data">Ageable</a></code>, <code><a href="type/AmethystCluster.html" title="interface in org.bukkit.block.data.type">AmethystCluster</a></code>, <code><a href="AnaloguePowerable.html" title="interface in org.bukkit.block.data">AnaloguePowerable</a></code>, <code><a href="Attachable.html" title="interface in org.bukkit.block.data">Attachable</a></code>, <code><a href="type/Bamboo.html" title="interface in org.bukkit.block.data.type">Bamboo</a></code>, <code><a href="type/Barrel.html" title="interface in org.bukkit.block.data.type">Barrel</a></code>, <code><a href="type/Bed.html" title="interface in org.bukkit.block.data.type">Bed</a></code>, <code><a href="type/Beehive.html" title="interface in org.bukkit.block.data.type">Beehive</a></code>, <code><a href="type/Bell.html" title="interface in org.bukkit.block.data.type">Bell</a></code>, <code><a href="type/BigDripleaf.html" title="interface in org.bukkit.block.data.type">BigDripleaf</a></code>, <code><a href="Bisected.html" title="interface in org.bukkit.block.data">Bisected</a></code>, <code><a href="type/BrewingStand.html" title="interface in org.bukkit.block.data.type">BrewingStand</a></code>, <code><a href="type/BubbleColumn.html" title="interface in org.bukkit.block.data.type">BubbleColumn</a></code>, <code><a href="type/Cake.html" title="interface in org.bukkit.block.data.type">Cake</a></code>, <code><a href="type/Campfire.html" title="interface in org.bukkit.block.data.type">Campfire</a></code>, <code><a href="type/Candle.html" title="interface in org.bukkit.block.data.type">Candle</a></code>, <code><a href="type/CaveVines.html" title="interface in org.bukkit.block.data.type">CaveVines</a></code>, <code><a href="type/CaveVinesPlant.html" title="interface in org.bukkit.block.data.type">CaveVinesPlant</a></code>, <code><a href="type/Chain.html" title="interface in org.bukkit.block.data.type">Chain</a></code>, <code><a href="type/Chest.html" title="interface in org.bukkit.block.data.type">Chest</a></code>, <code><a href="type/ChiseledBookshelf.html" title="interface in org.bukkit.block.data.type">ChiseledBookshelf</a></code>, <code><a href="type/Cocoa.html" title="interface in org.bukkit.block.data.type">Cocoa</a></code>, <code><a href="type/CommandBlock.html" title="interface in org.bukkit.block.data.type">CommandBlock</a></code>, <code><a href="type/Comparator.html" title="interface in org.bukkit.block.data.type">Comparator</a></code>, <code><a href="type/CoralWallFan.html" title="interface in org.bukkit.block.data.type">CoralWallFan</a></code>, <code><a href="type/DaylightDetector.html" title="interface in org.bukkit.block.data.type">DaylightDetector</a></code>, <code><a href="type/DecoratedPot.html" title="interface in org.bukkit.block.data.type">DecoratedPot</a></code>, <code><a href="Directional.html" title="interface in org.bukkit.block.data">Directional</a></code>, <code><a href="type/Dispenser.html" title="interface in org.bukkit.block.data.type">Dispenser</a></code>, <code><a href="type/Door.html" title="interface in org.bukkit.block.data.type">Door</a></code>, <code><a href="type/Dripleaf.html" title="interface in org.bukkit.block.data.type">Dripleaf</a></code>, <code><a href="type/EnderChest.html" title="interface in org.bukkit.block.data.type">EnderChest</a></code>, <code><a href="type/EndPortalFrame.html" title="interface in org.bukkit.block.data.type">EndPortalFrame</a></code>, <code><a href="FaceAttachable.html" title="interface in org.bukkit.block.data">FaceAttachable</a></code>, <code><a href="type/Farmland.html" title="interface in org.bukkit.block.data.type">Farmland</a></code>, <code><a href="type/Fence.html" title="interface in org.bukkit.block.data.type">Fence</a></code>, <code><a href="type/Fire.html" title="interface in org.bukkit.block.data.type">Fire</a></code>, <code><a href="type/Furnace.html" title="interface in org.bukkit.block.data.type">Furnace</a></code>, <code><a href="type/Gate.html" title="interface in org.bukkit.block.data.type">Gate</a></code>, <code><a href="ty
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">BlockData</span><span class="extends-implements">
extends <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></span></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></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockData.html" title="interface in org.bukkit.block.data">BlockData</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3">
<div class="block">Returns a copy of this BlockData.</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/23.0.0/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="#getAsString()" class="member-name-link">getAsString</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 a string, which when passed into a method such as
<a href="../../Server.html#createBlockData(java.lang.String)"><code>Server.createBlockData(java.lang.String)</code></a> will unambiguously
recreate this instance.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAsString(boolean)" class="member-name-link">getAsString</a><wbr>(boolean&nbsp;hideUnspecified)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a string, which when passed into a method such as
<a href="../../Server.html#createBlockData(java.lang.String)"><code>Server.createBlockData(java.lang.String)</code></a> will recreate this or a
similar instance where unspecified states (if any) may be optionally
omitted.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLightEmission()" class="member-name-link">getLightEmission</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get the amount of light emitted by this state when in the world.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../Material.html" title="enum class in org.bukkit">Material</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMaterial()" class="member-name-link">getMaterial</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 Material represented by this block data.</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/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../PistonMoveReaction.html" title="enum class in org.bukkit.block">PistonMoveReaction</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPistonMoveReaction()" class="member-name-link">getPistonMoveReaction</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 reaction of the block when moved by a piston</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../Material.html" title="enum class in org.bukkit">Material</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPlacementMaterial()" class="member-name-link">getPlacementMaterial</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets the material that a player would use to place this block.</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/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../SoundGroup.html" title="interface in org.bukkit">SoundGroup</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSoundGroup()" class="member-name-link">getSoundGroup</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 block's <a href="../../SoundGroup.html" title="interface in org.bukkit"><code>SoundGroup</code></a> which can be used to get its step
sound, hit sound, and others.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isFaceSturdy(org.bukkit.block.BlockFace,org.bukkit.block.BlockSupport)" class="member-name-link">isFaceSturdy</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face,
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../BlockSupport.html" title="enum class in org.bukkit.block">BlockSupport</a>&nbsp;support)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Checks if a state's <a href="../BlockFace.html" title="enum class in org.bukkit.block"><code>BlockFace</code></a> is capable of providing a given level
of <a href="../BlockSupport.html" title="enum class in org.bukkit.block"><code>BlockSupport</code></a> for neighbouring block states.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isOccluding()" class="member-name-link">isOccluding</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Check whether or not this state will occlude other blocks.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isPreferredTool(org.bukkit.inventory.ItemStack)" class="member-name-link">isPreferredTool</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a>&nbsp;tool)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns if the given item is a preferred choice to break this Block.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isRandomlyTicked()" class="member-name-link">isRandomlyTicked</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 if this block is ticked randomly in the world.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isSupported(org.bukkit.block.Block)" class="member-name-link">isSupported</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Block.html" title="interface in org.bukkit.block">Block</a>&nbsp;block)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Checks if this state would be properly supported if it were placed at
the given <a href="../Block.html" title="interface in org.bukkit.block"><code>Block</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isSupported(org.bukkit.Location)" class="member-name-link">isSupported</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../Location.html" title="class in org.bukkit">Location</a>&nbsp;location)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Checks if this state would be properly supported if it were placed at
the block at the given <a href="../../Location.html" title="class in org.bukkit"><code>Location</code></a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#matches(org.bukkit.block.data.BlockData)" class="member-name-link">matches</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="BlockData.html" title="interface in org.bukkit.block.data">BlockData</a>&nbsp;data)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Checks if the specified BlockData matches this block data.</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/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockData.html" title="interface in org.bukkit.block.data">BlockData</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#merge(org.bukkit.block.data.BlockData)" class="member-name-link">merge</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockData.html" title="interface in org.bukkit.block.data">BlockData</a>&nbsp;data)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Merges all explicitly set states from the given data with this BlockData.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#requiresCorrectToolForDrops()" class="member-name-link">requiresCorrectToolForDrops</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Check whether or not this state requires a specific item to be used to drop
items when broken.</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="getMaterial()">
<h3>getMaterial</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../Material.html" title="enum class in org.bukkit">Material</a></span>&nbsp;<span class="element-name">getMaterial</span>()</div>
<div class="block">Get the Material represented by this block data.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the material</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAsString()">
<h3>getAsString</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/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>&nbsp;<span class="element-name">getAsString</span>()</div>
<div class="block">Gets a string, which when passed into a method such as
<a href="../../Server.html#createBlockData(java.lang.String)"><code>Server.createBlockData(java.lang.String)</code></a> will unambiguously
recreate this instance.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>serialized data string for this block</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAsString(boolean)">
<h3>getAsString</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/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>&nbsp;<span class="element-name">getAsString</span><wbr><span class="parameters">(boolean&nbsp;hideUnspecified)</span></div>
<div class="block">Gets a string, which when passed into a method such as
<a href="../../Server.html#createBlockData(java.lang.String)"><code>Server.createBlockData(java.lang.String)</code></a> will recreate this or a
similar instance where unspecified states (if any) may be optionally
omitted. If this instance was parsed and states are omitted, this exact
instance will be creatable when parsed again, else their equality cannot
be guaranteed.
<p>
This method will only take effect for BlockData instances created by
methods such as <a href="../../Server.html#createBlockData(java.lang.String)"><code>Server.createBlockData(String)</code></a> or any similar
method whereby states are optionally defined. If otherwise, the result of
<a href="#getAsString()"><code>getAsString()</code></a> will be returned. The following behaviour would be
expected:
<pre><code>
String dataString = "minecraft:chest[waterlogged=true]"
BlockData data = Bukkit.createBlockData(dataString);
dataString.equals(data.getAsString(true)); // This would return true
dataString.equals(data.getAsString(false)); // This would return false as all states are present
dataString.equals(data.getAsString()); // This is equivalent to the above, "getAsString(false)"
</code></pre></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>hideUnspecified</code> - true if unspecified states should be omitted,
false if they are to be shown as performed by <a href="#getAsString()"><code>getAsString()</code></a>.</dd>
<dt>Returns:</dt>
<dd>serialized data string for this block</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="merge(org.bukkit.block.data.BlockData)">
<h3>merge</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockData.html" title="interface in org.bukkit.block.data">BlockData</a></span>&nbsp;<span class="element-name">merge</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/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/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockData.html" title="interface in org.bukkit.block.data">BlockData</a>&nbsp;data)</span></div>
<div class="block">Merges all explicitly set states from the given data with this BlockData.
<br>
Note that the given data MUST have been created from one of the String
parse methods, e.g. <a href="../../Server.html#createBlockData(java.lang.String)"><code>Server.createBlockData(java.lang.String)</code></a> and
not have been subsequently modified.
<br>
Note also that the block types must match identically.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>data</code> - the data to merge from</dd>
<dt>Returns:</dt>
<dd>a new instance of this blockdata with the merged data</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="matches(org.bukkit.block.data.BlockData)">
<h3>matches</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">matches</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/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/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="BlockData.html" title="interface in org.bukkit.block.data">BlockData</a>&nbsp;data)</span></div>
<div class="block">Checks if the specified BlockData matches this block data.
<br>
The semantics of this method are such that for manually created or
modified BlockData it has the same effect as
<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"><code>Object.equals(java.lang.Object)</code></a>, whilst for parsed data (that to
which <a href="#merge(org.bukkit.block.data.BlockData)"><code>merge(org.bukkit.block.data.BlockData)</code></a> applies, it will
return true when the type and all explicitly set states match.
<br>
<b>Note that these semantics mean that a.matches(b) may not be the same
as b.matches(a)</b></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>data</code> - the data to match against (normally a parsed constant)</dd>
<dt>Returns:</dt>
<dd>if there is a match</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="clone()">
<h3>clone</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockData.html" title="interface in org.bukkit.block.data">BlockData</a></span>&nbsp;<span class="element-name">clone</span>()</div>
<div class="block">Returns a copy of this BlockData.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>a copy of the block data</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSoundGroup()">
<h3>getSoundGroup</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../SoundGroup.html" title="interface in org.bukkit">SoundGroup</a></span>&nbsp;<span class="element-name">getSoundGroup</span>()</div>
<div class="block">Gets the block's <a href="../../SoundGroup.html" title="interface in org.bukkit"><code>SoundGroup</code></a> which can be used to get its step
sound, hit sound, and others.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the sound effect group</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLightEmission()">
<h3>getLightEmission</h3>
<div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">getLightEmission</span>()</div>
<div class="block">Get the amount of light emitted by this state when in the world.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the light emission</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isOccluding()">
<h3>isOccluding</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isOccluding</span>()</div>
<div class="block">Check whether or not this state will occlude other blocks.
<p>
Block state occlusion affects visual features of other blocks (e.g. leaves and
wet sponges will not spawn dripping water particles if an occluding state is
below it), or whether light will pass through it.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if occluding, false otherwise</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="requiresCorrectToolForDrops()">
<h3>requiresCorrectToolForDrops</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">requiresCorrectToolForDrops</span>()</div>
<div class="block">Check whether or not this state requires a specific item to be used to drop
items when broken. For example, diamond ore requires an iron pickaxe and will
not drop diamonds when broken with a wooden or stone pickaxe.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if a more specific item is required for drops, false if any item
(or an empty hand) will drop items</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isPreferredTool(org.bukkit.inventory.ItemStack)">
<h3>isPreferredTool</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isPreferredTool</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/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/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a>&nbsp;tool)</span></div>
<div class="block">Returns if the given item is a preferred choice to break this Block.
In some cases this determines if a block will drop anything or extra
loot.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>tool</code> - The tool or item used for breaking this block</dd>
<dt>Returns:</dt>
<dd>true if the tool is preferred for breaking this block.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getPistonMoveReaction()">
<h3>getPistonMoveReaction</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../PistonMoveReaction.html" title="enum class in org.bukkit.block">PistonMoveReaction</a></span>&nbsp;<span class="element-name">getPistonMoveReaction</span>()</div>
<div class="block">Returns the reaction of the block when moved by a piston</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>reaction</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isSupported(org.bukkit.block.Block)">
<h3>isSupported</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isSupported</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/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/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Block.html" title="interface in org.bukkit.block">Block</a>&nbsp;block)</span></div>
<div class="block">Checks if this state would be properly supported if it were placed at
the given <a href="../Block.html" title="interface in org.bukkit.block"><code>Block</code></a>.
<p>
This may be useful, for instance, to check whether or not a wall torch is
capable of surviving on its neighbouring block states.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>block</code> - the block position at which the state would be placed</dd>
<dt>Returns:</dt>
<dd>true if the block is supported, false if this state would not survive
the world conditions</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isSupported(org.bukkit.Location)">
<h3>isSupported</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isSupported</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/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/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../Location.html" title="class in org.bukkit">Location</a>&nbsp;location)</span></div>
<div class="block">Checks if this state would be properly supported if it were placed at
the block at the given <a href="../../Location.html" title="class in org.bukkit"><code>Location</code></a>.
<p>
This may be useful, for instance, to check whether or not a wall torch is
capable of surviving on its neighbouring block states.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>location</code> - the location at which the state would be placed</dd>
<dt>Returns:</dt>
<dd>true if the block is supported, false if this state would not survive
the world conditions</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isFaceSturdy(org.bukkit.block.BlockFace,org.bukkit.block.BlockSupport)">
<h3>isFaceSturdy</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isFaceSturdy</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/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/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face,
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/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/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../BlockSupport.html" title="enum class in org.bukkit.block">BlockSupport</a>&nbsp;support)</span></div>
<div class="block">Checks if a state's <a href="../BlockFace.html" title="enum class in org.bukkit.block"><code>BlockFace</code></a> is capable of providing a given level
of <a href="../BlockSupport.html" title="enum class in org.bukkit.block"><code>BlockSupport</code></a> for neighbouring block states.
<p>
Any given state may support either none, one, or more than one level of block
support depending on its states. A common example would be a wall's ability to support
torches only on the center of the upper block face, whereas a grass block would
support all levels of block support on all block faces.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>face</code> - the face to check</dd>
<dd><code>support</code> - the possible support level</dd>
<dt>Returns:</dt>
<dd>true if the face is sturdy and can support a block, false otherwise</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getPlacementMaterial()">
<h3>getPlacementMaterial</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../Material.html" title="enum class in org.bukkit">Material</a></span>&nbsp;<span class="element-name">getPlacementMaterial</span>()</div>
<div class="block">Gets the material that a player would use to place this block.
<p>
For most blocks this is the same as <a href="#getMaterial()"><code>getMaterial()</code></a> but some blocks
have different materials used to place them.
For example:
<pre>
<a href="../../Material.html#REDSTONE_WIRE"><code>Material.REDSTONE_WIRE</code></a> -> <a href="../../Material.html#REDSTONE"><code>Material.REDSTONE</code></a>
<a href="../../Material.html#CARROTS"><code>Material.CARROTS</code></a> -> <a href="../../Material.html#CARROT"><code>Material.CARROT</code></a>
</pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>placement material or <a href="../../Material.html#AIR"><code>Material.AIR</code></a> if it doesn't have one</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isRandomlyTicked()">
<h3>isRandomlyTicked</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isRandomlyTicked</span>()</div>
<div class="block">Gets if this block is ticked randomly in the world.
The blocks current state may change this value.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>is ticked randomly</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink