mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2024-07-03 07:30:02 +00:00
1508 lines
121 KiB
HTML
1508 lines
121 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>Block (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.block, interface: Block">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.bukkit.block</a></div>
|
|
<h1 title="Interface Block" class="title">Interface Block</h1>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Superinterfaces:</dt>
|
|
<dd><code><a href="../metadata/Metadatable.html" title="interface in org.bukkit.metadata">Metadatable</a></code>, <code><a href="https://jd.adventure.kyori.net/api/4.9.3/net/kyori/adventure/translation/Translatable.html" title="class or interface in net.kyori.adventure.translation" class="external-link">Translatable</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Block</span><span class="extends-implements">
|
|
extends <a href="../metadata/Metadatable.html" title="interface in org.bukkit.metadata">Metadatable</a>, <a href="https://jd.adventure.kyori.net/api/4.9.3/net/kyori/adventure/translation/Translatable.html" title="class or interface in net.kyori.adventure.translation" class="external-link">Translatable</a></span></div>
|
|
<div class="block">Represents a block. This is a live object, and only one Block may exist for
|
|
any given location in a world. The state of the block may change
|
|
concurrently to your own handling of it; use block.getState() to get a
|
|
snapshot state of a block which will not be modified.
|
|
|
|
<br>
|
|
Note that parts of this class which require access to the world at large
|
|
(i.e. lighting and power) may not be able to be safely accessed during world
|
|
generation when used in cases like BlockPhysicsEvent!!!!</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-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><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-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="#applyBoneMeal(org.bukkit.block.BlockFace)" class="member-name-link">applyBoneMeal</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a> face)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Simulate bone meal application to this block (if possible).</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="#breakNaturally()" class="member-name-link">breakNaturally</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Breaks the block and spawns items as if a player had digged it regardless
|
|
of the tool.</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="#breakNaturally(boolean)" class="member-name-link">breakNaturally</a><wbr>(boolean triggerEffect)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Breaks the block and spawns item drops as if a player had broken it</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="#breakNaturally(org.bukkit.inventory.ItemStack,boolean)" class="member-name-link">breakNaturally</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> tool,
|
|
boolean triggerEffect)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Breaks the block and spawns item drops as if a player had broken it
|
|
with a specific tool</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="#breakNaturally(org.bukkit.inventory.ItemStack)" class="member-name-link">breakNaturally</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="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> tool)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Breaks the block and spawns items as if a player had digged it with a
|
|
specific tool</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/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Biome.html" title="enum class in org.bukkit.block">Biome</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBiome()" class="member-name-link">getBiome</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 biome that this block resides in</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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="data/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="#getBlockData()" class="member-name-link">getBlockData</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 complete block data for this block</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getBlockKey()" class="member-name-link">getBlockKey</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 this block's coordinates packed into a long value.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static long</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#getBlockKey(int,int,int)" class="member-name-link">getBlockKey</a><wbr>(int x,
|
|
int y,
|
|
int z)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1">
|
|
<div class="block">Returns the specified block coordinates packed into a long value</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static int</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#getBlockKeyX(long)" class="member-name-link">getBlockKeyX</a><wbr>(long packed)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
|
|
<div class="block">Returns the x component from the packed value.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#getBlockKeyY(long)" class="member-name-link">getBlockKeyY</a><wbr>(long packed)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1">
|
|
<div class="block">Returns the y component from the packed value.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static int</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#getBlockKeyZ(long)" class="member-name-link">getBlockKeyZ</a><wbr>(long packed)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
|
|
<div class="block">Returns the z component from the packed value.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBlockPower()" class="member-name-link">getBlockPower</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Returns the redstone power being provided to this block</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="#getBlockPower(org.bukkit.block.BlockFace)" class="member-name-link">getBlockPower</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a> face)</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 redstone power being provided to this block face</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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../util/BoundingBox.html" title="class in org.bukkit.util">BoundingBox</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBoundingBox()" class="member-name-link">getBoundingBox</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 approximate bounding box for this block.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBreakSpeed(org.bukkit.entity.Player)" class="member-name-link">getBreakSpeed</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../entity/Player.html" title="interface in org.bukkit.entity">Player</a> player)</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 speed at which the given player would break this block, taking
|
|
into account tools, potion effects, whether or not the player is in
|
|
water, enchantments, etc.</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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Chunk.html" title="interface in org.bukkit">Chunk</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getChunk()" class="member-name-link">getChunk</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 chunk which contains 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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../util/VoxelShape.html" title="interface in org.bukkit.util">VoxelShape</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCollisionShape()" class="member-name-link">getCollisionShape</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 collision shape of this block.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>byte</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#getData()" class="member-name-link">getData</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Magic value</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default @org.jetbrains.annotations.NotNull float</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getDestroySpeed(org.bukkit.inventory.ItemStack)" class="member-name-link">getDestroySpeed</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> itemStack)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<div class="block">Gets the speed at which this block will be destroyed by a given <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>ItemStack</code></a></div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@org.jetbrains.annotations.NotNull float</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDestroySpeed(org.bukkit.inventory.ItemStack,boolean)" class="member-name-link">getDestroySpeed</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> itemStack,
|
|
boolean considerEnchants)</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 speed at which this blook will be destroyed by a given <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>ItemStack</code></a></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/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/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDrops()" class="member-name-link">getDrops</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 a list of items which would drop by destroying this block</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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDrops(org.bukkit.inventory.ItemStack,org.bukkit.entity.Entity)" class="member-name-link">getDrops</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> tool,
|
|
<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="../entity/Entity.html" title="interface in org.bukkit.entity">Entity</a> entity)</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 list of items which would drop by the entity destroying this
|
|
block with a specific tool</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/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/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDrops(org.bukkit.inventory.ItemStack)" class="member-name-link">getDrops</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="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> tool)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Returns a list of items which would drop by destroying this block with
|
|
a specific tool</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/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFace(org.bukkit.block.Block)" class="member-name-link">getFace</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Block.html" title="interface in org.bukkit.block">Block</a> block)</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 face relation of this block compared to the given block.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getHumidity()" class="member-name-link">getHumidity</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 humidity of the biome of this block</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLightFromBlocks()" class="member-name-link">getLightFromBlocks</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 amount of light at this block from nearby blocks.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLightFromSky()" class="member-name-link">getLightFromSky</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 at this block from the sky.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLightLevel()" class="member-name-link">getLightLevel</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 light level between 0-15</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/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></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLocation()" class="member-name-link">getLocation</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 Location of the block</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/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../Location.html" title="class in org.bukkit">Location</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLocation(org.bukkit.Location)" class="member-name-link">getLocation</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="../Location.html" title="class in org.bukkit">Location</a> loc)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Stores the location of the block in the provided Location 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/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/21.0.1/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></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRelative(int,int,int)" class="member-name-link">getRelative</a><wbr>(int modX,
|
|
int modY,
|
|
int modZ)</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 block at the given offsets</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/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></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRelative(org.bukkit.block.BlockFace)" class="member-name-link">getRelative</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a> face)</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 at the given face</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/21.0.1/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></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRelative(org.bukkit.block.BlockFace,int)" class="member-name-link">getRelative</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a> face,
|
|
int distance)</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 block at the given distance of the given face</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../../com/destroystokyo/paper/block/BlockSoundGroup.html" title="interface in com.destroystokyo.paper.block">BlockSoundGroup</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 <a href="../../../com/destroystokyo/paper/block/BlockSoundGroup.html" title="interface in com.destroystokyo.paper.block"><code>BlockSoundGroup</code></a> for this block.</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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockState.html" title="interface in org.bukkit.block">BlockState</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getState()" class="member-name-link">getState</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Captures the current state of 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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockState.html" title="interface in org.bukkit.block">BlockState</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getState(boolean)" class="member-name-link">getState</a><wbr>(boolean useSnapshot)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTemperature()" class="member-name-link">getTemperature</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 temperature of this block.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#getTranslationKey()" class="member-name-link">getTranslationKey</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">use <a href="https://jd.adventure.kyori.net/api/4.9.3/net/kyori/adventure/translation/Translatable.html#translationKey()" title="class or interface in net.kyori.adventure.translation" class="external-link"><code>Translatable.translationKey()</code></a></div>
|
|
</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/21.0.1/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="#getType()" class="member-name-link">getType</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 type of 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/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getWorld()" class="member-name-link">getWorld</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 world which contains this Block</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getX()" class="member-name-link">getX</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 x-coordinate of this block</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="#getY()" class="member-name-link">getY</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 y-coordinate of this block</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getZ()" class="member-name-link">getZ</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 z-coordinate of 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="#isBlockFaceIndirectlyPowered(org.bukkit.block.BlockFace)" class="member-name-link">isBlockFaceIndirectlyPowered</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a> face)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Returns true if the block face is being indirectly powered by Redstone.</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="#isBlockFacePowered(org.bukkit.block.BlockFace)" class="member-name-link">isBlockFacePowered</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a> face)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Returns true if the block face is being powered by Redstone.</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="#isBlockIndirectlyPowered()" class="member-name-link">isBlockIndirectlyPowered</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 true if the block is being indirectly powered by Redstone.</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="#isBlockPowered()" class="member-name-link">isBlockPowered</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 true if the block is being powered by Redstone.</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="#isBuildable()" class="member-name-link">isBuildable</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 if this block is solid</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="#isBurnable()" class="member-name-link">isBurnable</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 if this block is burnable</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="#isCollidable()" class="member-name-link">isCollidable</a>()</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 block is collidable.</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="#isEmpty()" class="member-name-link">isEmpty</a>()</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 block is empty.</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="#isLiquid()" class="member-name-link">isLiquid</a>()</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 block is liquid.</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="#isPassable()" class="member-name-link">isPassable</a>()</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 block is passable.</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="#isPreferredTool(org.bukkit.inventory.ItemStack)" class="member-name-link">isPreferredTool</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> tool)</code></div>
|
|
<div class="col-last odd-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 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="#isReplaceable()" class="member-name-link">isReplaceable</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 if this block is replaceable</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="#isSolid()" class="member-name-link">isSolid</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 if this block is solid</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="#isValidTool(org.bukkit.inventory.ItemStack)" class="member-name-link">isValidTool</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> itemStack)</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 itemstack is a valid tool to
|
|
break the block with</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="../util/RayTraceResult.html" title="class in org.bukkit.util">RayTraceResult</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#rayTrace(org.bukkit.Location,org.bukkit.util.Vector,double,org.bukkit.FluidCollisionMode)" class="member-name-link">rayTrace</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Location.html" title="class in org.bukkit">Location</a> start,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../util/Vector.html" title="class in org.bukkit.util">Vector</a> direction,
|
|
double maxDistance,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../FluidCollisionMode.html" title="enum class in org.bukkit">FluidCollisionMode</a> fluidCollisionMode)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Performs a ray trace that checks for collision with this specific block
|
|
in its current state using its precise collision shape.</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="#setBiome(org.bukkit.block.Biome)" class="member-name-link">setBiome</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Biome.html" title="enum class in org.bukkit.block">Biome</a> bio)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Sets the biome that this block resides in</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setBlockData(org.bukkit.block.data.BlockData)" class="member-name-link">setBlockData</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="data/BlockData.html" title="interface in org.bukkit.block.data">BlockData</a> data)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Sets the complete data for this block</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="#setBlockData(org.bukkit.block.data.BlockData,boolean)" class="member-name-link">setBlockData</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="data/BlockData.html" title="interface in org.bukkit.block.data">BlockData</a> data,
|
|
boolean applyPhysics)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Sets the complete data for this block
|
|
|
|
<br>
|
|
Note that applyPhysics = false is not in general safe.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setType(org.bukkit.Material)" class="member-name-link">setType</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Material.html" title="enum class in org.bukkit">Material</a> type)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Sets the type of this block</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="#setType(org.bukkit.Material,boolean)" class="member-name-link">setType</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Material.html" title="enum class in org.bukkit">Material</a> type,
|
|
boolean applyPhysics)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Sets the type of this block
|
|
|
|
<br>
|
|
Note that applyPhysics = false is not in general safe.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-org.bukkit.metadata.Metadatable">Methods inherited from interface org.bukkit.metadata.<a href="../metadata/Metadatable.html" title="interface in org.bukkit.metadata">Metadatable</a></h3>
|
|
<code><a href="../metadata/Metadatable.html#getMetadata(java.lang.String)">getMetadata</a>, <a href="../metadata/Metadatable.html#hasMetadata(java.lang.String)">hasMetadata</a>, <a href="../metadata/Metadatable.html#removeMetadata(java.lang.String,org.bukkit.plugin.Plugin)">removeMetadata</a>, <a href="../metadata/Metadatable.html#setMetadata(java.lang.String,org.bukkit.metadata.MetadataValue)">setMetadata</a></code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-net.kyori.adventure.translation.Translatable">Methods inherited from interface net.kyori.adventure.translation.<a href="https://jd.adventure.kyori.net/api/4.9.3/net/kyori/adventure/translation/Translatable.html" title="class or interface in net.kyori.adventure.translation" class="external-link">Translatable</a></h3>
|
|
<code><a href="https://jd.adventure.kyori.net/api/4.9.3/net/kyori/adventure/translation/Translatable.html#translationKey()" title="class or interface in net.kyori.adventure.translation" class="external-link">translationKey</a></code></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="getData()">
|
|
<h3>getData</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="return-type">byte</span> <span class="element-name">getData</span>()</div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Magic value</div>
|
|
</div>
|
|
<div class="block">Gets the metadata for this block</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>block specific metadata</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBlockData()">
|
|
<h3>getBlockData</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="data/BlockData.html" title="interface in org.bukkit.block.data">BlockData</a></span> <span class="element-name">getBlockData</span>()</div>
|
|
<div class="block">Gets the complete block data for this block</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>block specific data</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getRelative(int,int,int)">
|
|
<h3>getRelative</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Block.html" title="interface in org.bukkit.block">Block</a></span> <span class="element-name">getRelative</span><wbr><span class="parameters">(int modX,
|
|
int modY,
|
|
int modZ)</span></div>
|
|
<div class="block">Gets the block at the given offsets</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>modX</code> - X-coordinate offset</dd>
|
|
<dd><code>modY</code> - Y-coordinate offset</dd>
|
|
<dd><code>modZ</code> - Z-coordinate offset</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Block at the given offsets</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getRelative(org.bukkit.block.BlockFace)">
|
|
<h3>getRelative</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Block.html" title="interface in org.bukkit.block">Block</a></span> <span class="element-name">getRelative</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a> face)</span></div>
|
|
<div class="block">Gets the block at the given face
|
|
<p>
|
|
This method is equal to getRelative(face, 1)</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>face</code> - Face of this block to return</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Block at the given face</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list-long">
|
|
<li><a href="#getRelative(org.bukkit.block.BlockFace,int)"><code>getRelative(BlockFace, int)</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getRelative(org.bukkit.block.BlockFace,int)">
|
|
<h3>getRelative</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Block.html" title="interface in org.bukkit.block">Block</a></span> <span class="element-name">getRelative</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a> face,
|
|
int distance)</span></div>
|
|
<div class="block">Gets the block at the given distance of the given face
|
|
<p>
|
|
For example, the following method places water at 100,102,100; two
|
|
blocks above 100,100,100.
|
|
|
|
<pre>
|
|
Block block = world.getBlockAt(100, 100, 100);
|
|
Block shower = block.getRelative(BlockFace.UP, 2);
|
|
shower.setType(Material.WATER);
|
|
</pre></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>face</code> - Face of this block to return</dd>
|
|
<dd><code>distance</code> - Distance to get the block at</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Block at the given face</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getType()">
|
|
<h3>getType</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Material.html" title="enum class in org.bukkit">Material</a></span> <span class="element-name">getType</span>()</div>
|
|
<div class="block">Gets the type of this block</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>block type</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getLightLevel()">
|
|
<h3>getLightLevel</h3>
|
|
<div class="member-signature"><span class="return-type">byte</span> <span class="element-name">getLightLevel</span>()</div>
|
|
<div class="block">Gets the light level between 0-15</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>light level</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getLightFromSky()">
|
|
<h3>getLightFromSky</h3>
|
|
<div class="member-signature"><span class="return-type">byte</span> <span class="element-name">getLightFromSky</span>()</div>
|
|
<div class="block">Get the amount of light at this block from the sky.
|
|
<p>
|
|
Any light given from other sources (such as blocks like torches) will
|
|
be ignored.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Sky light level</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getLightFromBlocks()">
|
|
<h3>getLightFromBlocks</h3>
|
|
<div class="member-signature"><span class="return-type">byte</span> <span class="element-name">getLightFromBlocks</span>()</div>
|
|
<div class="block">Get the amount of light at this block from nearby blocks.
|
|
<p>
|
|
Any light given from other sources (such as the sun) will be ignored.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Block light level</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getWorld()">
|
|
<h3>getWorld</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../World.html" title="interface in org.bukkit">World</a></span> <span class="element-name">getWorld</span>()</div>
|
|
<div class="block">Gets the world which contains this Block</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>World containing this block</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getX()">
|
|
<h3>getX</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getX</span>()</div>
|
|
<div class="block">Gets the x-coordinate of this block</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>x-coordinate</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getY()">
|
|
<h3>getY</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getY</span>()</div>
|
|
<div class="block">Gets the y-coordinate of this block</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>y-coordinate</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getZ()">
|
|
<h3>getZ</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getZ</span>()</div>
|
|
<div class="block">Gets the z-coordinate of this block</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>z-coordinate</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBlockKey()">
|
|
<h3>getBlockKey</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name">getBlockKey</span>()</div>
|
|
<div class="block">Returns this block's coordinates packed into a long value.
|
|
Computed via: <code>Block.getBlockKey(this.getX(), this.getY(), this.getZ())</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>This block's x, y, and z coordinates packed into a long value</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list-long">
|
|
<li><a href="#getBlockKey(int,int,int)"><code>getBlockKey(int, int, int)</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBlockKey(int,int,int)">
|
|
<h3>getBlockKey</h3>
|
|
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type">long</span> <span class="element-name">getBlockKey</span><wbr><span class="parameters">(int x,
|
|
int y,
|
|
int z)</span></div>
|
|
<div class="block">Returns the specified block coordinates packed into a long value
|
|
<p>
|
|
The return value can be computed as follows:
|
|
<br>
|
|
<code>long value = ((long)x & 0x7FFFFFF) | (((long)z & 0x7FFFFFF) << 27) | ((long)y << 54);</code>
|
|
</p>
|
|
|
|
<p>
|
|
And may be unpacked as follows:
|
|
<br>
|
|
<code>int x = (int) ((packed << 37) >> 37);</code>
|
|
<br>
|
|
<code>int y = (int) (packed >>> 54);</code>
|
|
<br>
|
|
<code>int z = (int) ((packed << 10) >> 37);</code>
|
|
</p></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>This block's x, y, and z coordinates packed into a long value</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBlockKeyX(long)">
|
|
<h3>getBlockKeyX</h3>
|
|
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type">int</span> <span class="element-name">getBlockKeyX</span><wbr><span class="parameters">(long packed)</span></div>
|
|
<div class="block">Returns the x component from the packed value.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>packed</code> - The packed value, as computed by <a href="#getBlockKey(int,int,int)"><code>getBlockKey(int, int, int)</code></a></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The x component from the packed value.</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list-long">
|
|
<li><a href="#getBlockKey(int,int,int)"><code>getBlockKey(int, int, int)</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBlockKeyY(long)">
|
|
<h3>getBlockKeyY</h3>
|
|
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type">int</span> <span class="element-name">getBlockKeyY</span><wbr><span class="parameters">(long packed)</span></div>
|
|
<div class="block">Returns the y component from the packed value.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>packed</code> - The packed value, as computed by <a href="#getBlockKey(int,int,int)"><code>getBlockKey(int, int, int)</code></a></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The y component from the packed value.</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list-long">
|
|
<li><a href="#getBlockKey(int,int,int)"><code>getBlockKey(int, int, int)</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBlockKeyZ(long)">
|
|
<h3>getBlockKeyZ</h3>
|
|
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type">int</span> <span class="element-name">getBlockKeyZ</span><wbr><span class="parameters">(long packed)</span></div>
|
|
<div class="block">Returns the z component from the packed value.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>packed</code> - The packed value, as computed by <a href="#getBlockKey(int,int,int)"><code>getBlockKey(int, int, int)</code></a></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The z component from the packed value.</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list-long">
|
|
<li><a href="#getBlockKey(int,int,int)"><code>getBlockKey(int, int, int)</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isValidTool(org.bukkit.inventory.ItemStack)">
|
|
<h3>isValidTool</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isValidTool</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> itemStack)</span></div>
|
|
<div class="block">Checks if the itemstack is a valid tool to
|
|
break the block with</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>itemStack</code> - The (tool) itemstack</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>whether the block will drop items</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getLocation()">
|
|
<h3>getLocation</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">getLocation</span>()</div>
|
|
<div class="block">Gets the Location of the block</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Location of block</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getLocation(org.bukkit.Location)">
|
|
<h3>getLocation</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Contract.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Contract</a>("null -> null; !null -> !null")
|
|
<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="../Location.html" title="class in org.bukkit">Location</a></span> <span class="element-name">getLocation</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="../Location.html" title="class in org.bukkit">Location</a> loc)</span></div>
|
|
<div class="block">Stores the location of the block in the provided Location object.
|
|
<p>
|
|
If the provided Location is null this method does nothing and returns
|
|
null.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>loc</code> - the location to copy into</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The Location object provided or null</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getChunk()">
|
|
<h3>getChunk</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Chunk.html" title="interface in org.bukkit">Chunk</a></span> <span class="element-name">getChunk</span>()</div>
|
|
<div class="block">Gets the chunk which contains this block</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Containing Chunk</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setBlockData(org.bukkit.block.data.BlockData)">
|
|
<h3>setBlockData</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setBlockData</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="data/BlockData.html" title="interface in org.bukkit.block.data">BlockData</a> data)</span></div>
|
|
<div class="block">Sets the complete data for this block</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>data</code> - new block specific data</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setBlockData(org.bukkit.block.data.BlockData,boolean)">
|
|
<h3>setBlockData</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setBlockData</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="data/BlockData.html" title="interface in org.bukkit.block.data">BlockData</a> data,
|
|
boolean applyPhysics)</span></div>
|
|
<div class="block">Sets the complete data for this block
|
|
|
|
<br>
|
|
Note that applyPhysics = false is not in general safe. It should only be
|
|
used when you need to avoid triggering a physics update of neighboring
|
|
blocks, for example when creating a <a href="data/Bisected.html" title="interface in org.bukkit.block.data"><code>Bisected</code></a> block. If you are
|
|
using a custom populator, then this parameter may also be required to
|
|
prevent triggering infinite chunk loads on border blocks. This method
|
|
should NOT be used to "hack" physics by placing blocks in impossible
|
|
locations. Such blocks are liable to be removed on various events such as
|
|
world upgrades. Furthermore setting large amounts of such blocks in close
|
|
proximity may overload the server physics engine if an update is
|
|
triggered at a later point. If this occurs, the resulting behavior is
|
|
undefined.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>data</code> - new block specific data</dd>
|
|
<dd><code>applyPhysics</code> - false to cancel physics from the changed block</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setType(org.bukkit.Material)">
|
|
<h3>setType</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setType</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Material.html" title="enum class in org.bukkit">Material</a> type)</span></div>
|
|
<div class="block">Sets the type of this block</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>type</code> - Material to change this block to</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setType(org.bukkit.Material,boolean)">
|
|
<h3>setType</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setType</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Material.html" title="enum class in org.bukkit">Material</a> type,
|
|
boolean applyPhysics)</span></div>
|
|
<div class="block">Sets the type of this block
|
|
|
|
<br>
|
|
Note that applyPhysics = false is not in general safe. It should only be
|
|
used when you need to avoid triggering a physics update of neighboring
|
|
blocks, for example when creating a <a href="data/Bisected.html" title="interface in org.bukkit.block.data"><code>Bisected</code></a> block. If you are
|
|
using a custom populator, then this parameter may also be required to
|
|
prevent triggering infinite chunk loads on border blocks. This method
|
|
should NOT be used to "hack" physics by placing blocks in impossible
|
|
locations. Such blocks are liable to be removed on various events such as
|
|
world upgrades. Furthermore setting large amounts of such blocks in close
|
|
proximity may overload the server physics engine if an update is
|
|
triggered at a later point. If this occurs, the resulting behavior is
|
|
undefined.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>type</code> - Material to change this block to</dd>
|
|
<dd><code>applyPhysics</code> - False to cancel physics on the changed block.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getFace(org.bukkit.block.Block)">
|
|
<h3>getFace</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="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a></span> <span class="element-name">getFace</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Block.html" title="interface in org.bukkit.block">Block</a> block)</span></div>
|
|
<div class="block">Gets the face relation of this block compared to the given block.
|
|
<p>
|
|
For example:
|
|
<pre><code>
|
|
Block current = world.getBlockAt(100, 100, 100);
|
|
Block target = world.getBlockAt(100, 101, 100);
|
|
|
|
current.getFace(target) == BlockFace.Up;
|
|
</code></pre>
|
|
<br>
|
|
If the given block is not connected to this block, null may be returned</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>block</code> - Block to compare against this block</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>BlockFace of this block which has the requested block, or null</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getState()">
|
|
<h3>getState</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockState.html" title="interface in org.bukkit.block">BlockState</a></span> <span class="element-name">getState</span>()</div>
|
|
<div class="block">Captures the current state of this block. You may then cast that state
|
|
into any accepted type, such as Furnace or Sign.
|
|
<p>
|
|
The returned object will never be updated, and you are not guaranteed
|
|
that (for example) a sign is still a sign after you capture its state.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>BlockState with the current state of this block.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getState(boolean)">
|
|
<h3>getState</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockState.html" title="interface in org.bukkit.block">BlockState</a></span> <span class="element-name">getState</span><wbr><span class="parameters">(boolean useSnapshot)</span></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>useSnapshot</code> - if this block is a TE, should we create a fully copy of the TileEntity</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>BlockState with the current state of this block</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list-long">
|
|
<li><a href="#getState()"><code>optionally disables use of snapshot, to operate on real block data</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBiome()">
|
|
<h3>getBiome</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Biome.html" title="enum class in org.bukkit.block">Biome</a></span> <span class="element-name">getBiome</span>()</div>
|
|
<div class="block">Returns the biome that this block resides in</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Biome type containing this block</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setBiome(org.bukkit.block.Biome)">
|
|
<h3>setBiome</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setBiome</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Biome.html" title="enum class in org.bukkit.block">Biome</a> bio)</span></div>
|
|
<div class="block">Sets the biome that this block resides in</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>bio</code> - new Biome type for this block</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isBlockPowered()">
|
|
<h3>isBlockPowered</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isBlockPowered</span>()</div>
|
|
<div class="block">Returns true if the block is being powered by Redstone.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>True if the block is powered.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isBlockIndirectlyPowered()">
|
|
<h3>isBlockIndirectlyPowered</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isBlockIndirectlyPowered</span>()</div>
|
|
<div class="block">Returns true if the block is being indirectly powered by Redstone.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>True if the block is indirectly powered.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isBlockFacePowered(org.bukkit.block.BlockFace)">
|
|
<h3>isBlockFacePowered</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isBlockFacePowered</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a> face)</span></div>
|
|
<div class="block">Returns true if the block face is being powered by Redstone.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>face</code> - The block face</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>True if the block face is powered.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isBlockFaceIndirectlyPowered(org.bukkit.block.BlockFace)">
|
|
<h3>isBlockFaceIndirectlyPowered</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isBlockFaceIndirectlyPowered</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a> face)</span></div>
|
|
<div class="block">Returns true if the block face is being indirectly powered by Redstone.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>face</code> - The block face</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>True if the block face is indirectly powered.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBlockPower(org.bukkit.block.BlockFace)">
|
|
<h3>getBlockPower</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getBlockPower</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a> face)</span></div>
|
|
<div class="block">Returns the redstone power being provided to this block face</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>face</code> - the face of the block to query or BlockFace.SELF for the
|
|
block itself</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The power level.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBlockPower()">
|
|
<h3>getBlockPower</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getBlockPower</span>()</div>
|
|
<div class="block">Returns the redstone power being provided to this block</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The power level.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isEmpty()">
|
|
<h3>isEmpty</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div>
|
|
<div class="block">Checks if this block is empty.
|
|
<p>
|
|
A block is considered empty when <a href="#getType()"><code>getType()</code></a> returns <a href="../Material.html#AIR"><code>Material.AIR</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if this block is empty</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isLiquid()">
|
|
<h3>isLiquid</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isLiquid</span>()</div>
|
|
<div class="block">Checks if this block is liquid.
|
|
<p>
|
|
A block is considered liquid when <a href="#getType()"><code>getType()</code></a> returns <a href="../Material.html#WATER"><code>Material.WATER</code></a> or <a href="../Material.html#LAVA"><code>Material.LAVA</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if this block is liquid</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isBuildable()">
|
|
<h3>isBuildable</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isBuildable</span>()</div>
|
|
<div class="block">Check if this block is solid
|
|
<p>
|
|
Determined by Minecraft, typically a block a player can use to place a new block to build things.
|
|
An example of a non buildable block would be liquids, flowers, or fire</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if block is buildable</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isBurnable()">
|
|
<h3>isBurnable</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isBurnable</span>()</div>
|
|
<div class="block">Check if this block is burnable
|
|
<p>
|
|
Determined by Minecraft, typically a block that fire can destroy (Wool, Wood)</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if block is burnable</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isReplaceable()">
|
|
<h3>isReplaceable</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isReplaceable</span>()</div>
|
|
<div class="block">Check if this block is replaceable
|
|
<p>
|
|
Determined by Minecraft, representing a block that is not AIR that you can still place a new block at, such as flowers.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if block is replaceable</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isSolid()">
|
|
<h3>isSolid</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isSolid</span>()</div>
|
|
<div class="block">Check if this block is solid
|
|
<p>
|
|
Determined by Minecraft, typically a block a player can stand on and can't be passed through.
|
|
|
|
This API is faster than accessing Material#isSolid as it avoids a material lookup and switch statement.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if block is solid</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isCollidable()">
|
|
<h3>isCollidable</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isCollidable</span>()</div>
|
|
<div class="block">Checks if this block is collidable.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if collidable</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getTemperature()">
|
|
<h3>getTemperature</h3>
|
|
<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getTemperature</span>()</div>
|
|
<div class="block">Gets the temperature of this block.
|
|
<p>
|
|
If the raw biome temperature without adjusting for height effects is
|
|
required then please use <a href="../World.html#getTemperature(int,int)"><code>World.getTemperature(int, int)</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Temperature of this block</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getHumidity()">
|
|
<h3>getHumidity</h3>
|
|
<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getHumidity</span>()</div>
|
|
<div class="block">Gets the humidity of the biome of this block</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Humidity of 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/21.0.1/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/21.0.1/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> <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="breakNaturally()">
|
|
<h3>breakNaturally</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">breakNaturally</span>()</div>
|
|
<div class="block">Breaks the block and spawns items as if a player had digged it regardless
|
|
of the tool.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if the block was destroyed</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="breakNaturally(org.bukkit.inventory.ItemStack)">
|
|
<h3>breakNaturally</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">breakNaturally</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="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> tool)</span></div>
|
|
<div class="block">Breaks the block and spawns items as if a player had digged it with a
|
|
specific tool</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>tool</code> - The tool or item in hand used for digging</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the block was destroyed</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="breakNaturally(boolean)">
|
|
<h3>breakNaturally</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">breakNaturally</span><wbr><span class="parameters">(boolean triggerEffect)</span></div>
|
|
<div class="block">Breaks the block and spawns item drops as if a player had broken it</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>triggerEffect</code> - Play the block break particle effect and sound</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the block was destroyed</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="breakNaturally(org.bukkit.inventory.ItemStack,boolean)">
|
|
<h3>breakNaturally</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">breakNaturally</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> tool,
|
|
boolean triggerEffect)</span></div>
|
|
<div class="block">Breaks the block and spawns item drops as if a player had broken it
|
|
with a specific tool</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>tool</code> - The tool or item in hand used for digging</dd>
|
|
<dd><code>triggerEffect</code> - Play the block break particle effect and sound</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the block was destroyed</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="applyBoneMeal(org.bukkit.block.BlockFace)">
|
|
<h3>applyBoneMeal</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">applyBoneMeal</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a> face)</span></div>
|
|
<div class="block">Simulate bone meal application to this block (if possible).</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>face</code> - the face on which bonemeal should be applied</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the block was bonemealed, false otherwise</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDrops()">
|
|
<h3>getDrops</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a>></span> <span class="element-name">getDrops</span>()</div>
|
|
<div class="block">Returns a list of items which would drop by destroying this block</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>a list of dropped items for this type of block</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDrops(org.bukkit.inventory.ItemStack)">
|
|
<h3>getDrops</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a>></span> <span class="element-name">getDrops</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="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> tool)</span></div>
|
|
<div class="block">Returns a list of items which would drop by destroying this block with
|
|
a specific tool</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>tool</code> - The tool or item in hand used for digging</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>a list of dropped items for this type of block</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDrops(org.bukkit.inventory.ItemStack,org.bukkit.entity.Entity)">
|
|
<h3>getDrops</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a>></span> <span class="element-name">getDrops</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> tool,
|
|
<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="../entity/Entity.html" title="interface in org.bukkit.entity">Entity</a> entity)</span></div>
|
|
<div class="block">Returns a list of items which would drop by the entity destroying this
|
|
block with a specific tool</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>tool</code> - The tool or item in hand used for digging</dd>
|
|
<dd><code>entity</code> - the entity destroying the block</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>a list of dropped items for this type of block</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> <span class="element-name">isPreferredTool</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> 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="getBreakSpeed(org.bukkit.entity.Player)">
|
|
<h3>getBreakSpeed</h3>
|
|
<div class="member-signature"><span class="return-type">float</span> <span class="element-name">getBreakSpeed</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../entity/Player.html" title="interface in org.bukkit.entity">Player</a> player)</span></div>
|
|
<div class="block">Gets the speed at which the given player would break this block, taking
|
|
into account tools, potion effects, whether or not the player is in
|
|
water, enchantments, etc.
|
|
|
|
The returned value is the amount of progress made in breaking the block.
|
|
When the total breaking progress reaches <code>1.0f</code>, the block is
|
|
broken. Note that the break speed can change in the course of breaking a
|
|
block, e.g. if a potion effect is applied or expires, or the player
|
|
jumps/enters water.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>player</code> - player breaking the block</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the speed at which the player breaks this block</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isPassable()">
|
|
<h3>isPassable</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isPassable</span>()</div>
|
|
<div class="block">Checks if this block is passable.
|
|
<p>
|
|
A block is passable if it has no colliding parts that would prevent
|
|
players from moving through it.
|
|
<p>
|
|
Examples: Tall grass, flowers, signs, etc. are passable, but open doors,
|
|
fence gates, trap doors, etc. are not because they still have parts that
|
|
can be collided with.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd><code>true</code> if passable</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="rayTrace(org.bukkit.Location,org.bukkit.util.Vector,double,org.bukkit.FluidCollisionMode)">
|
|
<h3>rayTrace</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="../util/RayTraceResult.html" title="class in org.bukkit.util">RayTraceResult</a></span> <span class="element-name">rayTrace</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../Location.html" title="class in org.bukkit">Location</a> start,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../util/Vector.html" title="class in org.bukkit.util">Vector</a> direction,
|
|
double maxDistance,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../FluidCollisionMode.html" title="enum class in org.bukkit">FluidCollisionMode</a> fluidCollisionMode)</span></div>
|
|
<div class="block">Performs a ray trace that checks for collision with this specific block
|
|
in its current state using its precise collision shape.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>start</code> - the start location</dd>
|
|
<dd><code>direction</code> - the ray direction</dd>
|
|
<dd><code>maxDistance</code> - the maximum distance</dd>
|
|
<dd><code>fluidCollisionMode</code> - the fluid collision mode</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the ray trace hit result, or <code>null</code> if there is no hit</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBoundingBox()">
|
|
<h3>getBoundingBox</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../util/BoundingBox.html" title="class in org.bukkit.util">BoundingBox</a></span> <span class="element-name">getBoundingBox</span>()</div>
|
|
<div class="block">Gets the approximate bounding box for this block.
|
|
<p>
|
|
This isn't exact as some blocks <a href="data/type/Stairs.html" title="interface in org.bukkit.block.data.type"><code>Stairs</code></a>
|
|
contain many bounding boxes to establish their complete form.
|
|
|
|
Also, the box may not be exactly the same as the collision shape (such as
|
|
cactus, which is 16/16 of a block with 15/16 collisional bounds).
|
|
|
|
This method will return an empty bounding box if the geometric shape of
|
|
the block is empty (such as air blocks).</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the approximate bounding box of the block</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getCollisionShape()">
|
|
<h3>getCollisionShape</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../util/VoxelShape.html" title="interface in org.bukkit.util">VoxelShape</a></span> <span class="element-name">getCollisionShape</span>()</div>
|
|
<div class="block">Gets the collision shape of this block.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>a <a href="../util/VoxelShape.html" title="interface in org.bukkit.util"><code>VoxelShape</code></a> representing the collision shape of this
|
|
block.</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/21.0.1/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="../../../com/destroystokyo/paper/block/BlockSoundGroup.html" title="interface in com.destroystokyo.paper.block">BlockSoundGroup</a></span> <span class="element-name">getSoundGroup</span>()</div>
|
|
<div class="block">Gets the <a href="../../../com/destroystokyo/paper/block/BlockSoundGroup.html" title="interface in com.destroystokyo.paper.block"><code>BlockSoundGroup</code></a> for this block.
|
|
<p>
|
|
This object contains the block, step, place, hit, and fall sounds.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the sound group for this block</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getTranslationKey()">
|
|
<h3>getTranslationKey</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<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="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getTranslationKey</span>()</div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">use <a href="https://jd.adventure.kyori.net/api/4.9.3/net/kyori/adventure/translation/Translatable.html#translationKey()" title="class or interface in net.kyori.adventure.translation" class="external-link"><code>Translatable.translationKey()</code></a></div>
|
|
</div>
|
|
<div class="block">Return the translation key for the Block, so the client can translate it into the active
|
|
locale when using a TranslatableComponent.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the translation key</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDestroySpeed(org.bukkit.inventory.ItemStack)">
|
|
<h3>getDestroySpeed</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="modifiers">default</span> <span class="return-type">@org.jetbrains.annotations.NotNull float</span> <span class="element-name">getDestroySpeed</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> itemStack)</span></div>
|
|
<div class="block">Gets the speed at which this block will be destroyed by a given <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>ItemStack</code></a>
|
|
|
|
<p>Default value is 1.0</p></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>itemStack</code> - <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>ItemStack</code></a> used to mine this Block</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the speed that this Block will be mined by the given <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>ItemStack</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDestroySpeed(org.bukkit.inventory.ItemStack,boolean)">
|
|
<h3>getDestroySpeed</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type">@org.jetbrains.annotations.NotNull float</span> <span class="element-name">getDestroySpeed</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory">ItemStack</a> itemStack,
|
|
boolean considerEnchants)</span></div>
|
|
<div class="block">Gets the speed at which this blook will be destroyed by a given <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>ItemStack</code></a>
|
|
<p>
|
|
Default value is 1.0</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>itemStack</code> - <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>ItemStack</code></a> used to mine this Block</dd>
|
|
<dd><code>considerEnchants</code> - true to look at enchants on the itemstack</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the speed that this Block will be mined by the given <a href="../inventory/ItemStack.html" title="class in org.bukkit.inventory"><code>ItemStack</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|