1
mirror of https://github.com/StarWishsama/Slimefun4.git synced 2024-09-20 03:35:51 +00:00
Slimefun4/docs/me/mrCookieSlime/Slimefun/Objects/SlimefunBlockHandler.html
2020-04-04 13:23:04 +00:00

328 lines
17 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (9.0.4.1) on Sat Apr 04 13:23:00 UTC 2020 -->
<title>SlimefunBlockHandler (Slimefun4 - Javadocs)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-04-04">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-1.10.2.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SlimefunBlockHandler (Slimefun4 - Javadocs)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SlimefunBlockHandler.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../me/mrCookieSlime/Slimefun/Objects/Research.html" title="class in me.mrCookieSlime.Slimefun.Objects"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?me/mrCookieSlime/Slimefun/Objects/SlimefunBlockHandler.html" target="_top">Frames</a></li>
<li><a href="SlimefunBlockHandler.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="../../../../me/mrCookieSlime/Slimefun/Objects/package-summary.html">me.mrCookieSlime.Slimefun.Objects</a></div>
<h2 title="Interface SlimefunBlockHandler" class="title">Interface SlimefunBlockHandler</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Functional Interface:</dt>
<dd>This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.</dd>
</dl>
<hr>
<br>
<pre><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/FunctionalInterface.html?is-external=true" title="class or interface in java.lang">@FunctionalInterface</a>
public interface <span class="typeNameLabel">SlimefunBlockHandler</span></pre>
<div class="block">A <a href="../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunBlockHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects"><code>SlimefunBlockHandler</code></a> handles breaking and placing of blocks.
You can use this class to initialize block data but also to correctly
destroy blocks.
<code>SlimefunItem.registerBlockHandler(String, SlimefunBlockHandler); </code></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>TheBusyBiscuit</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunBlockHandler.html#onBreak-org.bukkit.entity.Player-org.bukkit.block.Block-me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem-me.mrCookieSlime.Slimefun.Objects.SlimefunItem.UnregisterReason-">onBreak</a></span>&#8203;(<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true" title="class or interface in org.bukkit.entity">Player</a>&nbsp;p,
<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block">Block</a>&nbsp;b,
<a href="../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunItem/SlimefunItem.html" title="class in me.mrCookieSlime.Slimefun.Objects.SlimefunItem">SlimefunItem</a>&nbsp;item,
<a href="../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunItem/UnregisterReason.html" title="enum in me.mrCookieSlime.Slimefun.Objects.SlimefunItem">UnregisterReason</a>&nbsp;reason)</code></th>
<td class="colLast">
<div class="block">This method gets called when the <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block"><code>Block</code></a> is broken.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunBlockHandler.html#onPlace-org.bukkit.entity.Player-org.bukkit.block.Block-me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem-">onPlace</a></span>&#8203;(<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true" title="class or interface in org.bukkit.entity">Player</a>&nbsp;p,
<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block">Block</a>&nbsp;b,
<a href="../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunItem/SlimefunItem.html" title="class in me.mrCookieSlime.Slimefun.Objects.SlimefunItem">SlimefunItem</a>&nbsp;item)</code></th>
<td class="colLast">
<div class="block">This method gets called when the <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block"><code>Block</code></a> is placed.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="onPlace-org.bukkit.entity.Player-org.bukkit.block.Block-me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onPlace</h4>
<pre>default&nbsp;void&nbsp;onPlace&#8203;(<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true" title="class or interface in org.bukkit.entity">Player</a>&nbsp;p,
<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block">Block</a>&nbsp;b,
<a href="../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunItem/SlimefunItem.html" title="class in me.mrCookieSlime.Slimefun.Objects.SlimefunItem">SlimefunItem</a>&nbsp;item)</pre>
<div class="block">This method gets called when the <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block"><code>Block</code></a> is placed.
Use this method to initialize block data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p</code> - The <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true" title="class or interface in org.bukkit.entity"><code>Player</code></a> who placed it</dd>
<dd><code>b</code> - The <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block"><code>Block</code></a> that was placed</dd>
<dd><code>item</code> - The <a href="../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunItem/SlimefunItem.html" title="class in me.mrCookieSlime.Slimefun.Objects.SlimefunItem"><code>SlimefunItem</code></a> that will be stored inside the <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block"><code>Block</code></a></dd>
</dl>
</li>
</ul>
<a id="onBreak-org.bukkit.entity.Player-org.bukkit.block.Block-me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem-me.mrCookieSlime.Slimefun.Objects.SlimefunItem.UnregisterReason-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onBreak</h4>
<pre>boolean&nbsp;onBreak&#8203;(<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true" title="class or interface in org.bukkit.entity">Player</a>&nbsp;p,
<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block">Block</a>&nbsp;b,
<a href="../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunItem/SlimefunItem.html" title="class in me.mrCookieSlime.Slimefun.Objects.SlimefunItem">SlimefunItem</a>&nbsp;item,
<a href="../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunItem/UnregisterReason.html" title="enum in me.mrCookieSlime.Slimefun.Objects.SlimefunItem">UnregisterReason</a>&nbsp;reason)</pre>
<div class="block">This method gets called when the <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block"><code>Block</code></a> is broken.
The <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true" title="class or interface in org.bukkit.entity"><code>Player</code></a> will be null if the <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block"><code>Block</code></a> exploded</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p</code> - The <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Player.html?is-external=true" title="class or interface in org.bukkit.entity"><code>Player</code></a> who broke the <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block"><code>Block</code></a></dd>
<dd><code>b</code> - The <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block"><code>Block</code></a> that was broken</dd>
<dd><code>item</code> - The <a href="../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunItem/SlimefunItem.html" title="class in me.mrCookieSlime.Slimefun.Objects.SlimefunItem"><code>SlimefunItem</code></a> that was stored in that <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block"><code>Block</code></a></dd>
<dd><code>reason</code> - The reason for the <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block"><code>Block</code></a> breaking</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/event/Event.html?is-external=true" title="class or interface in org.bukkit.event"><code>Event</code></a> should be cancelled</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SlimefunBlockHandler.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../me/mrCookieSlime/Slimefun/Objects/Research.html" title="class in me.mrCookieSlime.Slimefun.Objects"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?me/mrCookieSlime/Slimefun/Objects/SlimefunBlockHandler.html" target="_top">Frames</a></li>
<li><a href="SlimefunBlockHandler.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2020. All rights reserved.</small></p>
</footer>
</body>
</html>