CustomNPC-Plus/docs/noppes/npcs/scripted/interfaces/ITileEntity.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_331) on Tue Aug 16 13:33:15 CDT 2022 -->
<title>ITileEntity</title>
<meta name="date" content="2022-08-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="ITileEntity";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="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="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../noppes/npcs/scripted/interfaces/ISkinOverlay.html" title="interface in noppes.npcs.scripted.interfaces"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html" title="interface in noppes.npcs.scripted.interfaces"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?noppes/npcs/scripted/interfaces/ITileEntity.html" target="_top">Frames</a></li>
<li><a href="ITileEntity.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>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</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 name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">noppes.npcs.scripted.interfaces</div>
<h2 title="Interface ITileEntity" class="title">Interface ITileEntity</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ITileEntity</span></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITileEntity.html#getBlockMetadata--">getBlockMetadata</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../noppes/npcs/scripted/interfaces/IBlock.html" title="interface in noppes.npcs.scripted.interfaces">IBlock</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITileEntity.html#getBlockType--">getBlockType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITileEntity.html#getDistanceFrom-double-double-double-">getDistanceFrom</a></span>(double&nbsp;x,
               double&nbsp;y,
               double&nbsp;z)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>net.minecraft.tileentity.TileEntity</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITileEntity.html#getMCTileEntity--">getMCTileEntity</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../noppes/npcs/scripted/interfaces/INbt.html" title="interface in noppes.npcs.scripted.interfaces">INbt</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITileEntity.html#getNBT--">getNBT</a></span>()</code>
<div class="block">Writes the tile entity to NBT and returns the compound tag.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>noppes.npcs.scripted.ScriptWorld</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITileEntity.html#getWorld--">getWorld</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITileEntity.html#invalidate--">invalidate</a></span>()</code>
<div class="block">Invalidates the tile entity.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITileEntity.html#isInvalid--">isInvalid</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITileEntity.html#readFromNBT-noppes.npcs.scripted.interfaces.INbt-">readFromNBT</a></span>(<a href="../../../../noppes/npcs/scripted/interfaces/INbt.html" title="interface in noppes.npcs.scripted.interfaces">INbt</a>&nbsp;nbt)</code>
<div class="block">Reads an INbt compound tag, creates a tile entity based on the data, and replaces this entity with the new one.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITileEntity.html#updateContainingBlockInfo--">updateContainingBlockInfo</a></span>()</code>
<div class="block">Updates the block's tile entity to the values set in this object.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITileEntity.html#validate--">validate</a></span>()</code>
<div class="block">Validates the tile entity for use.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getBlockMetadata--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBlockMetadata</h4>
<pre>int&nbsp;getBlockMetadata()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An integer representing the metadata of this block. Blocks with different states will
 return different values. For example, each stage of growth for a wheat crop will return a different value, each
 orientation of a stair block will return a different value, etc.</dd>
</dl>
</li>
</ul>
<a name="getWorld--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorld</h4>
<pre>noppes.npcs.scripted.ScriptWorld&nbsp;getWorld()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The world this tile entity is in.</dd>
</dl>
</li>
</ul>
<a name="getMCTileEntity--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMCTileEntity</h4>
<pre>net.minecraft.tileentity.TileEntity&nbsp;getMCTileEntity()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An obfuscated MC tile entity object.</dd>
</dl>
</li>
</ul>
<a name="readFromNBT-noppes.npcs.scripted.interfaces.INbt-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readFromNBT</h4>
<pre>void&nbsp;readFromNBT(<a href="../../../../noppes/npcs/scripted/interfaces/INbt.html" title="interface in noppes.npcs.scripted.interfaces">INbt</a>&nbsp;nbt)</pre>
<div class="block">Reads an INbt compound tag, creates a tile entity based on the data, and replaces this entity with the new one.</div>
</li>
</ul>
<a name="getDistanceFrom-double-double-double-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDistanceFrom</h4>
<pre>double&nbsp;getDistanceFrom(double&nbsp;x,
                       double&nbsp;y,
                       double&nbsp;z)</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The distance of this tile entity from the point given by the x, y, and z parameters.</dd>
</dl>
</li>
</ul>
<a name="getBlockType--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBlockType</h4>
<pre><a href="../../../../noppes/npcs/scripted/interfaces/IBlock.html" title="interface in noppes.npcs.scripted.interfaces">IBlock</a>&nbsp;getBlockType()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new IBlock object based on this tile entity's type.</dd>
</dl>
</li>
</ul>
<a name="isInvalid--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInvalid</h4>
<pre>boolean&nbsp;isInvalid()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the tile entity is invalid, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="invalidate--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invalidate</h4>
<pre>void&nbsp;invalidate()</pre>
<div class="block">Invalidates the tile entity.</div>
</li>
</ul>
<a name="validate--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validate</h4>
<pre>void&nbsp;validate()</pre>
<div class="block">Validates the tile entity for use.</div>
</li>
</ul>
<a name="updateContainingBlockInfo--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateContainingBlockInfo</h4>
<pre>void&nbsp;updateContainingBlockInfo()</pre>
<div class="block">Updates the block's tile entity to the values set in this object.</div>
</li>
</ul>
<a name="getNBT--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getNBT</h4>
<pre><a href="../../../../noppes/npcs/scripted/interfaces/INbt.html" title="interface in noppes.npcs.scripted.interfaces">INbt</a>&nbsp;getNBT()</pre>
<div class="block">Writes the tile entity to NBT and returns the compound tag.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="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="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../noppes/npcs/scripted/interfaces/ISkinOverlay.html" title="interface in noppes.npcs.scripted.interfaces"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html" title="interface in noppes.npcs.scripted.interfaces"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?noppes/npcs/scripted/interfaces/ITileEntity.html" target="_top">Frames</a></li>
<li><a href="ITileEntity.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>
</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 name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>