1
mirror of https://github.com/StarWishsama/Slimefun4.git synced 2024-09-20 11:45:51 +00:00
Slimefun4/docs/me/mrCookieSlime/Slimefun/Objects/handlers/MultiBlockInteractionHandler.html

325 lines
17 KiB
HTML
Raw Normal View History

2020-03-21 18:04:45 +00:00
<!DOCTYPE HTML>
2020-03-05 20:28:50 +00:00
<!-- NewPage -->
2020-03-21 18:04:45 +00:00
<html lang="en">
2020-03-05 20:28:50 +00:00
<head>
2020-03-21 20:19:39 +00:00
<!-- Generated by javadoc (9.0.4.1) on Sat Mar 21 20:19:36 UTC 2020 -->
2020-03-21 18:04:45 +00:00
<title>MultiBlockInteractionHandler (Slimefun4 - Javadocs)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-03-21">
2020-03-05 20:28:50 +00:00
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
2020-03-21 18:04:45 +00:00
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
2020-03-05 20:28:50 +00:00
<script type="text/javascript" src="../../../../../script.js"></script>
2020-03-21 18:04:45 +00:00
<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>
2020-03-05 20:28:50 +00:00
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
2020-03-21 18:04:45 +00:00
parent.document.title="MultiBlockInteractionHandler (Slimefun4 - Javadocs)";
2020-03-05 20:28:50 +00:00
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":6};
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";
2020-03-21 18:04:45 +00:00
var pathtoroot = "../../../../../";loadScripts(document, 'script');</script>
2020-03-05 20:28:50 +00:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2020-03-21 18:04:45 +00:00
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
2020-03-05 20:28:50 +00:00
<!-- ========= START OF TOP NAVBAR ======= -->
2020-03-21 18:04:45 +00:00
<div class="topNav"><a id="navbar.top">
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
2020-03-21 18:04:45 +00:00
<a id="navbar.top.firstrow">
2020-03-05 20:28:50 +00:00
<!-- -->
</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/MultiBlockInteractionHandler.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
2020-03-21 18:04:45 +00:00
<li><a href="../../../../../index-all.html">Index</a></li>
2020-03-05 20:28:50 +00:00
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemUseHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/RainbowTicker.html" title="class in me.mrCookieSlime.Slimefun.Objects.handlers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?me/mrCookieSlime/Slimefun/Objects/handlers/MultiBlockInteractionHandler.html" target="_top">Frames</a></li>
<li><a href="MultiBlockInteractionHandler.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>
2020-03-21 18:04:45 +00:00
<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>
2020-03-05 20:28:50 +00:00
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
2020-03-21 18:04:45 +00:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2020-03-05 20:28:50 +00:00
</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>
2020-03-21 18:04:45 +00:00
<a id="skip.navbar.top">
2020-03-05 20:28:50 +00:00
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
2020-03-21 18:04:45 +00:00
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
2020-03-05 20:28:50 +00:00
<!-- ======== START OF CLASS DATA ======== -->
2020-03-21 18:04:45 +00:00
<main role="main">
2020-03-05 20:28:50 +00:00
<div class="header">
2020-03-21 18:04:45 +00:00
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/package-summary.html">me.mrCookieSlime.Slimefun.Objects.handlers</a></div>
2020-03-05 20:28:50 +00:00
<h2 title="Interface MultiBlockInteractionHandler" class="title">Interface MultiBlockInteractionHandler</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
2020-03-21 18:04:45 +00:00
<dd><code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers">ItemHandler</a></code></dd>
2020-03-05 20:28:50 +00:00
</dl>
<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>
2020-03-21 18:04:45 +00:00
<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>
2020-03-05 20:28:50 +00:00
public interface <span class="typeNameLabel">MultiBlockInteractionHandler</span>
extends <a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers">ItemHandler</a></pre>
<div class="block">This <a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers"><code>ItemHandler</code></a> is called whenever a <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> interacts with
this <a href="../../../../../io/github/thebusybiscuit/slimefun4/core/MultiBlock.html" title="class in io.github.thebusybiscuit.slimefun4.core"><code>MultiBlock</code></a>.
Note that this <a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/MultiBlockInteractionHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers"><code>MultiBlockInteractionHandler</code></a> should be assigned to
a class that inherits from <a href="../../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunItem/multiblocks/MultiBlockMachine.html" title="class in me.mrCookieSlime.Slimefun.Objects.SlimefunItem.multiblocks"><code>MultiBlockMachine</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>TheBusyBiscuit</dd>
2020-03-06 00:22:54 +00:00
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers"><code>ItemHandler</code></a>,
<a href="../../../../../io/github/thebusybiscuit/slimefun4/core/MultiBlock.html" title="class in io.github.thebusybiscuit.slimefun4.core"><code>MultiBlock</code></a>,
<a href="../../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunItem/multiblocks/MultiBlockMachine.html" title="class in me.mrCookieSlime.Slimefun.Objects.SlimefunItem.multiblocks"><code>MultiBlockMachine</code></a></dd>
2020-03-05 20:28:50 +00:00
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
2020-03-21 18:04:45 +00:00
<section role="region">
2020-03-05 20:28:50 +00:00
<ul class="blockList">
2020-03-21 18:04:45 +00:00
<li class="blockList"><a id="method.summary">
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<h3>Method Summary</h3>
2020-03-21 18:04:45 +00:00
<table class="memberSummary">
2020-03-05 20:28:50 +00:00
<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>
2020-03-21 18:04:45 +00:00
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
2020-03-05 20:28:50 +00:00
</tr>
<tr id="i0" class="altColor">
2020-03-21 18:04:45 +00:00
<td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers">ItemHandler</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/MultiBlockInteractionHandler.html#getIdentifier--">getIdentifier</a></span>&#8203;()</code></th>
<td class="colLast">
2020-03-05 20:28:50 +00:00
<div class="block">This method returns the identifier for this <a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers"><code>ItemHandler</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
2020-03-21 18:04:45 +00:00
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/MultiBlockInteractionHandler.html#onInteract-org.bukkit.entity.Player-io.github.thebusybiscuit.slimefun4.core.MultiBlock-org.bukkit.block.Block-">onInteract</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,
2020-03-05 20:28:50 +00:00
<a href="../../../../../io/github/thebusybiscuit/slimefun4/core/MultiBlock.html" title="class in io.github.thebusybiscuit.slimefun4.core">MultiBlock</a>&nbsp;mb,
2020-03-21 18:04:45 +00:00
<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)</code></th>
<td class="colLast">&nbsp;</td>
2020-03-05 20:28:50 +00:00
</tr>
</table>
<ul class="blockList">
2020-03-21 18:04:45 +00:00
<li class="blockList"><a id="methods.inherited.from.class.me.mrCookieSlime.Slimefun.Objects.handlers.ItemHandler">
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;me.mrCookieSlime.Slimefun.Objects.handlers.<a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers">ItemHandler</a></h3>
<code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html#isPrivate--">isPrivate</a></code></li>
</ul>
</li>
</ul>
2020-03-21 18:04:45 +00:00
</section>
2020-03-05 20:28:50 +00:00
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
2020-03-21 18:04:45 +00:00
<section role="region">
2020-03-05 20:28:50 +00:00
<ul class="blockList">
2020-03-21 18:04:45 +00:00
<li class="blockList"><a id="method.detail">
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<h3>Method Detail</h3>
2020-03-21 18:04:45 +00:00
<a id="onInteract-org.bukkit.entity.Player-io.github.thebusybiscuit.slimefun4.core.MultiBlock-org.bukkit.block.Block-">
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onInteract</h4>
2020-03-21 18:04:45 +00:00
<pre>boolean&nbsp;onInteract&#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,
2020-03-05 20:28:50 +00:00
<a href="../../../../../io/github/thebusybiscuit/slimefun4/core/MultiBlock.html" title="class in io.github.thebusybiscuit.slimefun4.core">MultiBlock</a>&nbsp;mb,
<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)</pre>
</li>
</ul>
2020-03-21 18:04:45 +00:00
<a id="getIdentifier--">
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getIdentifier</h4>
2020-03-21 18:04:45 +00:00
<pre>default&nbsp;<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers">ItemHandler</a>&gt;&nbsp;getIdentifier&#8203;()</pre>
2020-03-05 20:28:50 +00:00
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html#getIdentifier--">ItemHandler</a></code></span></div>
<div class="block">This method returns the identifier for this <a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers"><code>ItemHandler</code></a>.
2020-03-21 18:04:45 +00:00
We use a <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang"><code>Class</code></a> identifier to group Item Handlers together.</div>
2020-03-05 20:28:50 +00:00
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html#getIdentifier--">getIdentifier</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers">ItemHandler</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
2020-03-21 18:04:45 +00:00
<dd>The <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang"><code>Class</code></a> identifier for this <a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers"><code>ItemHandler</code></a></dd>
2020-03-05 20:28:50 +00:00
</dl>
</li>
</ul>
</li>
</ul>
2020-03-21 18:04:45 +00:00
</section>
2020-03-05 20:28:50 +00:00
</li>
</ul>
</div>
</div>
2020-03-21 18:04:45 +00:00
</main>
2020-03-05 20:28:50 +00:00
<!-- ========= END OF CLASS DATA ========= -->
2020-03-21 18:04:45 +00:00
<footer role="contentinfo">
<nav role="navigation">
2020-03-05 20:28:50 +00:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2020-03-21 18:04:45 +00:00
<div class="bottomNav"><a id="navbar.bottom">
2020-03-05 20:28:50 +00:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
2020-03-21 18:04:45 +00:00
<a id="navbar.bottom.firstrow">
2020-03-05 20:28:50 +00:00
<!-- -->
</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/MultiBlockInteractionHandler.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
2020-03-21 18:04:45 +00:00
<li><a href="../../../../../index-all.html">Index</a></li>
2020-03-05 20:28:50 +00:00
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemUseHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/RainbowTicker.html" title="class in me.mrCookieSlime.Slimefun.Objects.handlers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?me/mrCookieSlime/Slimefun/Objects/handlers/MultiBlockInteractionHandler.html" target="_top">Frames</a></li>
<li><a href="MultiBlockInteractionHandler.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>
2020-03-21 18:04:45 +00:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2020-03-05 20:28:50 +00:00
</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>
2020-03-21 18:04:45 +00:00
<a id="skip.navbar.bottom">
2020-03-05 20:28:50 +00:00
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2020-03-21 18:04:45 +00:00
</nav>
<p class="legalCopy"><small>Copyright &#169; 2020. All rights reserved.</small></p>
</footer>
2020-03-05 20:28:50 +00:00
</body>
</html>