Files
StructureLib/master/javadoc/com/gtnewhorizon/structurelib/StructureLibAPI.html
T

1393 lines
73 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>StructureLibAPI (StructureLib 1.4.27 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/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="../../../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-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StructureLibAPI (StructureLib 1.4.27 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":41,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9,"i24":9,"i25":9,"i26":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
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="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="../../../index.html?com/gtnewhorizon/structurelib/StructureLibAPI.html" target="_top">Frames</a></li>
<li><a href="StructureLibAPI.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><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" 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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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="package-summary.html">com.gtnewhorizon.structurelib</a></div>
<h2 title="Class StructureLibAPI" class="title">Class StructureLibAPI</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.gtnewhorizon.structurelib.StructureLibAPI</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">StructureLibAPI</span>
extends java.lang.Object</pre>
<div class="block">A stable interface into the structure lib's internals. Backwards compatibility is maintained to the maximum extend
possible.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CHANNEL_SHOW_ERROR">CHANNEL_SHOW_ERROR</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_AIR">HINT_BLOCK_META_AIR</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_DEFAULT">HINT_BLOCK_META_DEFAULT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_ERROR">HINT_BLOCK_META_ERROR</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_GENERIC_0">HINT_BLOCK_META_GENERIC_0</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_GENERIC_1">HINT_BLOCK_META_GENERIC_1</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_GENERIC_10">HINT_BLOCK_META_GENERIC_10</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_GENERIC_11">HINT_BLOCK_META_GENERIC_11</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_GENERIC_2">HINT_BLOCK_META_GENERIC_2</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_GENERIC_3">HINT_BLOCK_META_GENERIC_3</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_GENERIC_4">HINT_BLOCK_META_GENERIC_4</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_GENERIC_5">HINT_BLOCK_META_GENERIC_5</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_GENERIC_6">HINT_BLOCK_META_GENERIC_6</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_GENERIC_7">HINT_BLOCK_META_GENERIC_7</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_GENERIC_8">HINT_BLOCK_META_GENERIC_8</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_GENERIC_9">HINT_BLOCK_META_GENERIC_9</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HINT_BLOCK_META_NOT_AIR">HINT_BLOCK_META_NOT_AIR</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MOD_ID">MOD_ID</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">StructureLibAPI</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addThrottledChat(java.lang.Object,net.minecraft.entity.player.EntityPlayer,net.minecraft.util.IChatComponent,short)">addThrottledChat</a></span>&#8203;(java.lang.Object&nbsp;throttleKey,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayer</a>&nbsp;player,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/util/IChatComponent.html?is-external=true" title="class or interface in net.minecraft.util" class="externalLink">IChatComponent</a>&nbsp;text,
short&nbsp;intervalRequired)</code></th>
<td class="colLast">
<div class="block">Send chat to player, but throttled.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addThrottledChat(java.lang.Object,net.minecraft.entity.player.EntityPlayer,net.minecraft.util.IChatComponent,short,boolean)">addThrottledChat</a></span>&#8203;(java.lang.Object&nbsp;throttleKey,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayer</a>&nbsp;player,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/util/IChatComponent.html?is-external=true" title="class or interface in net.minecraft.util" class="externalLink">IChatComponent</a>&nbsp;text,
short&nbsp;intervalRequired,
boolean&nbsp;forceUpdateLastSend)</code></th>
<td class="colLast">
<div class="block">Send chat to player, but throttled.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disableInstrument()">disableInstrument</a></span>()</code></th>
<td class="colLast">
<div class="block">Stop instrumenting.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enableInstrument(java.lang.Object)">enableInstrument</a></span>&#8203;(java.lang.Object&nbsp;identifier)</code></th>
<td class="colLast">
<div class="block">Start instrumenting <b>for the current thread only</b>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#endHinting(net.minecraft.world.World)">endHinting</a></span>&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w)</code></th>
<td class="colLast">
<div class="block">End current batch of hinting.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/block/Block.html?is-external=true" title="class or interface in net.minecraft.block" class="externalLink">Block</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBlockHint()">getBlockHint</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the Block for StructureLib supplied hint block.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/item/Item.html?is-external=true" title="class or interface in net.minecraft.item" class="externalLink">Item</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultHologramItem()">getDefaultHologramItem</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the hologram item.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/item/Item.html?is-external=true" title="class or interface in net.minecraft.item" class="externalLink">Item</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getItemBlockHint()">getItemBlockHint</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the ItemBlock for StructureLib supplied hint block.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hintParticle(net.minecraft.world.World,int,int,int,net.minecraft.block.Block,int)">hintParticle</a></span>&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/block/Block.html?is-external=true" title="class or interface in net.minecraft.block" class="externalLink">Block</a>&nbsp;block,
int&nbsp;meta)</code></th>
<td class="colLast">
<div class="block">Generate a new hint particle on client side at given location using textures from given block.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hintParticle(net.minecraft.world.World,int,int,int,net.minecraft.util.IIcon%5B%5D)">hintParticle</a></span>&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/util/IIcon.html?is-external=true" title="class or interface in net.minecraft.util" class="externalLink">IIcon</a>[]&nbsp;icons)</code></th>
<td class="colLast">
<div class="block">Generate a new hint particle on client side at given location using given textures.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hintParticleTinted(net.minecraft.world.World,int,int,int,net.minecraft.block.Block,int,short%5B%5D)">hintParticleTinted</a></span>&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/block/Block.html?is-external=true" title="class or interface in net.minecraft.block" class="externalLink">Block</a>&nbsp;block,
int&nbsp;meta,
short[]&nbsp;RGBa)</code></th>
<td class="colLast">
<div class="block">Generate a new hint particle on client side at given location using textures from given block with a tint.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hintParticleTinted(net.minecraft.world.World,int,int,int,net.minecraft.util.IIcon%5B%5D,short%5B%5D)">hintParticleTinted</a></span>&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/util/IIcon.html?is-external=true" title="class or interface in net.minecraft.util" class="externalLink">IIcon</a>[]&nbsp;icons,
short[]&nbsp;RGBa)</code></th>
<td class="colLast">
<div class="block">Generate a new hint particle on client side at given location using given textures with a tint.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBlockTriviallyReplaceable(net.minecraft.world.World,int,int,int,net.minecraft.entity.player.EntityPlayer)">isBlockTriviallyReplaceable</a></span>&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayer</a>&nbsp;actor)</code></th>
<td class="colLast">
<div class="block">Determines if given block can be replaced without much effort.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBlockTriviallyReplaceable(net.minecraft.world.World,int,int,int,net.minecraft.entity.player.EntityPlayerMP)">isBlockTriviallyReplaceable</a></span>&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayerMP.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayerMP</a>&nbsp;actor)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDebugEnabled()">isDebugEnabled</a></span>()</code></th>
<td class="colLast">
<div class="block">Check if structure debug mode is on.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isInstrumentEnabled()">isInstrumentEnabled</a></span>()</code></th>
<td class="colLast">
<div class="block">Check if instrumenting is enabled.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#markHintParticleError(net.minecraft.entity.player.EntityPlayer,net.minecraft.world.World,int,int,int)">markHintParticleError</a></span>&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayer</a>&nbsp;player,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z)</code></th>
<td class="colLast">
<div class="block">Update the tint of given hint particle.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider)">queryAlignment</a></span>&#8203;(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider)</code></th>
<td class="colLast">
<div class="block">Query the ExtendedFacing of this tile entity from client side.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerChannelDescription(java.lang.String,java.lang.String,java.lang.String)">registerChannelDescription</a></span>&#8203;(java.lang.String&nbsp;channel,
java.lang.String&nbsp;modid,
java.lang.String&nbsp;description)</code></th>
<td class="colLast">
<div class="block">Register a channel description here.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerChannelItem(java.lang.String,java.lang.String,int,net.minecraft.item.ItemStack)">registerChannelItem</a></span>&#8203;(java.lang.String&nbsp;channel,
java.lang.String&nbsp;modid,
int&nbsp;channelValue,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/item/ItemStack.html?is-external=true" title="class or interface in net.minecraft.item" class="externalLink">ItemStack</a>&nbsp;stack)</code></th>
<td class="colLast">
<div class="block">Register an item stack as an indicator for a (channel, value) pair.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider)">sendAlignment</a></span>&#8203;(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider)</code></th>
<td class="colLast">
<div class="block">Send the ExtendedFacing of this Tile Entity to all players.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,cpw.mods.fml.common.network.NetworkRegistry.TargetPoint)">sendAlignment</a></span>&#8203;(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/cpw/mods/fml/common/network/NetworkRegistry.TargetPoint.html?is-external=true" title="class or interface in cpw.mods.fml.common.network" class="externalLink">NetworkRegistry.TargetPoint</a>&nbsp;targetPoint)</code></th>
<td class="colLast">
<div class="block">Send the ExtendedFacing of this Tile Entity to all players around target point.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,net.minecraft.entity.player.EntityPlayerMP)">sendAlignment</a></span>&#8203;(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayerMP.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayerMP</a>&nbsp;player)</code></th>
<td class="colLast">
<div class="block">Send the ExtendedFacing of this Tile Entity to given player.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,net.minecraft.world.World)">sendAlignment</a></span>&#8203;(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;dimension)</code></th>
<td class="colLast">
<div class="block">Send the ExtendedFacing of this Tile Entity to all players in that dimension.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDebugEnabled(boolean)">setDebugEnabled</a></span>&#8203;(boolean&nbsp;enabled)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startHinting(net.minecraft.world.World)">startHinting</a></span>&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w)</code></th>
<td class="colLast">
<div class="block">Start a batch of hinting.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateHintParticleTint(net.minecraft.entity.player.EntityPlayer,net.minecraft.world.World,int,int,int,short%5B%5D)">updateHintParticleTint</a></span>&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayer</a>&nbsp;player,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
short[]&nbsp;RGBa)</code></th>
<td class="colLast">
<div class="block">Update the tint of given hint particle.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="MOD_ID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MOD_ID</h4>
<pre>public static final&nbsp;java.lang.String MOD_ID</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.MOD_ID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_GENERIC_0">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_GENERIC_0</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_GENERIC_0</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_0">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_GENERIC_1">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_GENERIC_1</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_GENERIC_1</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_1">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_GENERIC_2">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_GENERIC_2</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_GENERIC_2</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_2">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_GENERIC_3">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_GENERIC_3</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_GENERIC_3</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_3">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_GENERIC_4">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_GENERIC_4</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_GENERIC_4</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_4">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_GENERIC_5">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_GENERIC_5</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_GENERIC_5</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_5">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_GENERIC_6">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_GENERIC_6</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_GENERIC_6</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_6">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_GENERIC_7">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_GENERIC_7</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_GENERIC_7</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_7">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_GENERIC_8">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_GENERIC_8</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_GENERIC_8</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_8">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_GENERIC_9">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_GENERIC_9</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_GENERIC_9</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_9">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_GENERIC_10">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_GENERIC_10</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_GENERIC_10</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_10">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_GENERIC_11">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_GENERIC_11</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_GENERIC_11</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_11">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_DEFAULT</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_DEFAULT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_AIR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_AIR</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_AIR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_AIR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_NOT_AIR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_NOT_AIR</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_NOT_AIR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_NOT_AIR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HINT_BLOCK_META_ERROR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HINT_BLOCK_META_ERROR</h4>
<pre>public static final&nbsp;int HINT_BLOCK_META_ERROR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_ERROR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="CHANNEL_SHOW_ERROR">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CHANNEL_SHOW_ERROR</h4>
<pre>public static final&nbsp;java.lang.String CHANNEL_SHOW_ERROR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.CHANNEL_SHOW_ERROR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StructureLibAPI</h4>
<pre>public&nbsp;StructureLibAPI()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="enableInstrument(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableInstrument</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;enableInstrument&#8203;(java.lang.Object&nbsp;identifier)</pre>
<div class="block">Start instrumenting <b>for the current thread only</b>. When instrumentation is enabled,
<a href="structure/IStructureDefinition.html" title="interface in com.gtnewhorizon.structurelib.structure"><code>IStructureDefinition</code></a>'s builtin iteration methods will send <a href="StructureEvent.html" title="class in com.gtnewhorizon.structurelib"><code>StructureEvent</code></a> and its subclasses when
appropriate. Otherwise, these events will not be sent at all, regardless of whether a listener for these events
are registered.
<p>
Identifiers are required to be value-comparable, i.e. overrides <code>Object.equals(Object)</code>. Suggested
identifier includes
<ul>
<li>Mod Instance or <a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/cpw/mods/fml/common/ModContainer.html?is-external=true" title="class or interface in cpw.mods.fml.common" class="externalLink"><code>ModContainer</code></a></li>
<li><a href="alignment/constructable/IConstructable.html" title="interface in com.gtnewhorizon.structurelib.alignment.constructable"><code>IConstructable</code></a> and its friends, if you are
triggering structure check via this interface.</li>
<li><a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/util/ResourceLocation.html?is-external=true" title="class or interface in net.minecraft.util" class="externalLink"><code>ResourceLocation</code></a></li>
</ul>
<p>
It's an API abuse for normal <a href="structure/IStructureDefinition.html" title="interface in com.gtnewhorizon.structurelib.structure"><code>IStructureDefinition</code></a> users to depend on this feature. They have full control
and full knowledge of the <a href="structure/IStructureDefinition.html" title="interface in com.gtnewhorizon.structurelib.structure"><code>IStructureDefinition</code></a> they are using. Using events to instrument the structure
check/autoplace is completely unnecessary and does nothing but add overhead.
<p>
Instruments are required to call <a href="#disableInstrument()"><code>disableInstrument()</code></a> whenever it is done with its business, as there can
be only one instrument for any given thread.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identifier</code> - an identifier sent along the actual event.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if instrument has already been enabled.</dd>
</dl>
</li>
</ul>
<a id="disableInstrument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableInstrument</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;disableInstrument()</pre>
<div class="block">Stop instrumenting.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if instrumenting hasn't been enabled.</dd>
</dl>
</li>
</ul>
<a id="isInstrumentEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInstrumentEnabled</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isInstrumentEnabled()</pre>
<div class="block">Check if instrumenting is enabled.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if enabled, false otherwise</dd>
</dl>
</li>
</ul>
<a id="startHinting(net.minecraft.world.World)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startHinting</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;startHinting&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w)</pre>
<div class="block">Start a batch of hinting. All hints particles generated during one batch will be considered to belong to one
hologram.
<p>
You don't need to call this unless your constructable tool didn't call
<a href="alignment/constructable/ConstructableUtility.html#handle(net.minecraft.item.ItemStack,net.minecraft.entity.player.EntityPlayer,net.minecraft.world.World,int,int,int,int)"><code>ConstructableUtility.handle(ItemStack, EntityPlayer, World, int, int, int, int)</code></a></div>
</li>
</ul>
<a id="endHinting(net.minecraft.world.World)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endHinting</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;endHinting&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w)</pre>
<div class="block">End current batch of hinting. All hints particles generated during one batch will be considered to belong to one
hologram.
<p>
You don't need to call this unless your constructable tool didn't call
<a href="alignment/constructable/ConstructableUtility.html#handle(net.minecraft.item.ItemStack,net.minecraft.entity.player.EntityPlayer,net.minecraft.world.World,int,int,int,int)"><code>ConstructableUtility.handle(ItemStack, EntityPlayer, World, int, int, int, int)</code></a></div>
</li>
</ul>
<a id="hintParticleTinted(net.minecraft.world.World,int,int,int,net.minecraft.util.IIcon[],short[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hintParticleTinted</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;hintParticleTinted&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/util/IIcon.html?is-external=true" title="class or interface in net.minecraft.util" class="externalLink">IIcon</a>[]&nbsp;icons,
short[]&nbsp;RGBa)</pre>
<div class="block">Generate a new hint particle on client side at given location using given textures with a tint.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>w</code> - World to spawn. Usually the client world.</dd>
<dd><code>x</code> - x coord</dd>
<dd><code>y</code> - y coord</dd>
<dd><code>z</code> - z coord</dd>
<dd><code>icons</code> - 6 texture. in forge direction order.</dd>
<dd><code>RGBa</code> - a 4 short array. tint in rgba form. currently alpha channel is ignored, but we might change this
later on.</dd>
</dl>
</li>
</ul>
<a id="hintParticleTinted(net.minecraft.world.World,int,int,int,net.minecraft.block.Block,int,short[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hintParticleTinted</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;hintParticleTinted&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/block/Block.html?is-external=true" title="class or interface in net.minecraft.block" class="externalLink">Block</a>&nbsp;block,
int&nbsp;meta,
short[]&nbsp;RGBa)</pre>
<div class="block">Generate a new hint particle on client side at given location using textures from given block with a tint.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>w</code> - World to spawn. Usually the client world.</dd>
<dd><code>x</code> - x coord</dd>
<dd><code>y</code> - y coord</dd>
<dd><code>z</code> - z coord</dd>
<dd><code>block</code> - block to take texture from</dd>
<dd><code>meta</code> - the meta of block to take texture from</dd>
<dd><code>RGBa</code> - a 4 short array. tint in rgba form. currently alpha channel is ignored, but we might change this
later on.</dd>
</dl>
</li>
</ul>
<a id="hintParticle(net.minecraft.world.World,int,int,int,net.minecraft.util.IIcon[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hintParticle</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;hintParticle&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/util/IIcon.html?is-external=true" title="class or interface in net.minecraft.util" class="externalLink">IIcon</a>[]&nbsp;icons)</pre>
<div class="block">Generate a new hint particle on client side at given location using given textures.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>w</code> - World to spawn. Usually the client world.</dd>
<dd><code>x</code> - x coord</dd>
<dd><code>y</code> - y coord</dd>
<dd><code>z</code> - z coord</dd>
<dd><code>icons</code> - 6 texture. in forge direction order.</dd>
</dl>
</li>
</ul>
<a id="hintParticle(net.minecraft.world.World,int,int,int,net.minecraft.block.Block,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hintParticle</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;hintParticle&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/block/Block.html?is-external=true" title="class or interface in net.minecraft.block" class="externalLink">Block</a>&nbsp;block,
int&nbsp;meta)</pre>
<div class="block">Generate a new hint particle on client side at given location using textures from given block.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>w</code> - World to spawn. Usually the client world.</dd>
<dd><code>x</code> - x coord</dd>
<dd><code>y</code> - y coord</dd>
<dd><code>z</code> - z coord</dd>
<dd><code>block</code> - block to take texture from</dd>
<dd><code>meta</code> - the meta of block to take texture from</dd>
</dl>
</li>
</ul>
<a id="markHintParticleError(net.minecraft.entity.player.EntityPlayer,net.minecraft.world.World,int,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>markHintParticleError</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;markHintParticleError&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayer</a>&nbsp;player,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z)</pre>
<div class="block">Update the tint of given hint particle. Do nothing if particle not found.
<p>
Can be called on either client side or server side. Server side will schedule a network message to update it for
this player only. Will do nothing if no hint particle is found at given location.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>false if nothing updated. true if updated or update instruction sent.</dd>
</dl>
</li>
</ul>
<a id="updateHintParticleTint(net.minecraft.entity.player.EntityPlayer,net.minecraft.world.World,int,int,int,short[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateHintParticleTint</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;updateHintParticleTint&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayer</a>&nbsp;player,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
short[]&nbsp;RGBa)</pre>
<div class="block">Update the tint of given hint particle. Do nothing if particle not found.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>false if nothing updated. true if updated.</dd>
</dl>
</li>
</ul>
<a id="queryAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryAlignment</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;queryAlignment&#8203;(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider)</pre>
<div class="block">Query the ExtendedFacing of this tile entity from client side. Can be sent only on client side. The
ExtendedFacing will later be set onto given tile entity via
<a href="alignment/IAlignment.html#setExtendedFacing(com.gtnewhorizon.structurelib.alignment.enumerable.ExtendedFacing)"><code>IAlignment.setExtendedFacing(ExtendedFacing)</code></a> upon arrival of
server reply.
<p>
The server side will query the <a href="alignment/enumerable/ExtendedFacing.html" title="enum in com.gtnewhorizon.structurelib.alignment.enumerable"><code>ExtendedFacing</code></a> of this provider using
<a href="alignment/IAlignment.html#getExtendedFacing()"><code>IAlignment.getExtendedFacing()</code></a></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if is not tile entity or provided a null alignment</dd>
</dl>
</li>
</ul>
<a id="sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendAlignment</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;sendAlignment&#8203;(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider)</pre>
<div class="block">Send the ExtendedFacing of this Tile Entity to all players. Can be called on server side only.
<p>
The receiving tile entity will receive the <a href="alignment/enumerable/ExtendedFacing.html" title="enum in com.gtnewhorizon.structurelib.alignment.enumerable"><code>ExtendedFacing</code></a> via its
<a href="alignment/IAlignment.html#setExtendedFacing(com.gtnewhorizon.structurelib.alignment.enumerable.ExtendedFacing)"><code>IAlignment.setExtendedFacing(ExtendedFacing)</code></a> method.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if is not tile entity or provided a null alignment</dd>
</dl>
</li>
</ul>
<a id="sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,net.minecraft.entity.player.EntityPlayerMP)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendAlignment</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;sendAlignment&#8203;(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayerMP.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayerMP</a>&nbsp;player)</pre>
<div class="block">Send the ExtendedFacing of this Tile Entity to given player. Can be called on server side only.
<p>
The receiving tile entity will receive the <a href="alignment/enumerable/ExtendedFacing.html" title="enum in com.gtnewhorizon.structurelib.alignment.enumerable"><code>ExtendedFacing</code></a> via its
<a href="alignment/IAlignment.html#setExtendedFacing(com.gtnewhorizon.structurelib.alignment.enumerable.ExtendedFacing)"><code>IAlignment.setExtendedFacing(ExtendedFacing)</code></a> method.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if is not tile entity or provided a null alignment</dd>
</dl>
</li>
</ul>
<a id="sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,cpw.mods.fml.common.network.NetworkRegistry.TargetPoint)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendAlignment</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;sendAlignment&#8203;(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/cpw/mods/fml/common/network/NetworkRegistry.TargetPoint.html?is-external=true" title="class or interface in cpw.mods.fml.common.network" class="externalLink">NetworkRegistry.TargetPoint</a>&nbsp;targetPoint)</pre>
<div class="block">Send the ExtendedFacing of this Tile Entity to all players around target point. Can be called on server side
only.
<p>
The receiving tile entity will receive the <a href="alignment/enumerable/ExtendedFacing.html" title="enum in com.gtnewhorizon.structurelib.alignment.enumerable"><code>ExtendedFacing</code></a> via its
<a href="alignment/IAlignment.html#setExtendedFacing(com.gtnewhorizon.structurelib.alignment.enumerable.ExtendedFacing)"><code>IAlignment.setExtendedFacing(ExtendedFacing)</code></a> method.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if is not tile entity or provided a null alignment</dd>
</dl>
</li>
</ul>
<a id="sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,net.minecraft.world.World)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendAlignment</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;sendAlignment&#8203;(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;dimension)</pre>
<div class="block">Send the ExtendedFacing of this Tile Entity to all players in that dimension. Can be called on server side only.
<p>
The receiving tile entity will receive the <a href="alignment/enumerable/ExtendedFacing.html" title="enum in com.gtnewhorizon.structurelib.alignment.enumerable"><code>ExtendedFacing</code></a> via its
<a href="alignment/IAlignment.html#setExtendedFacing(com.gtnewhorizon.structurelib.alignment.enumerable.ExtendedFacing)"><code>IAlignment.setExtendedFacing(ExtendedFacing)</code></a> method.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if is not tile entity or provided a null alignment</dd>
</dl>
</li>
</ul>
<a id="getBlockHint()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBlockHint</h4>
<pre class="methodSignature">public static&nbsp;<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/block/Block.html?is-external=true" title="class or interface in net.minecraft.block" class="externalLink">Block</a>&nbsp;getBlockHint()</pre>
<div class="block">Get the Block for StructureLib supplied hint block.</div>
</li>
</ul>
<a id="getItemBlockHint()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getItemBlockHint</h4>
<pre class="methodSignature">public static&nbsp;<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/item/Item.html?is-external=true" title="class or interface in net.minecraft.item" class="externalLink">Item</a>&nbsp;getItemBlockHint()</pre>
<div class="block">Get the ItemBlock for StructureLib supplied hint block.</div>
</li>
</ul>
<a id="getDefaultHologramItem()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultHologramItem</h4>
<pre class="methodSignature">public static&nbsp;<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/item/Item.html?is-external=true" title="class or interface in net.minecraft.item" class="externalLink">Item</a>&nbsp;getDefaultHologramItem()</pre>
<div class="block">Get the hologram item.</div>
</li>
</ul>
<a id="isDebugEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDebugEnabled</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isDebugEnabled()</pre>
<div class="block">Check if structure debug mode is on.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if debug mode is on</dd>
</dl>
</li>
</ul>
<a id="setDebugEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDebugEnabled</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;setDebugEnabled&#8203;(boolean&nbsp;enabled)</pre>
</li>
</ul>
<a id="isBlockTriviallyReplaceable(net.minecraft.world.World,int,int,int,net.minecraft.entity.player.EntityPlayerMP)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBlockTriviallyReplaceable</h4>
<pre class="methodSignature">@Deprecated
public static&nbsp;boolean&nbsp;isBlockTriviallyReplaceable&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayerMP.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayerMP</a>&nbsp;actor)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Determines if given block can be replaced without much effort. The exact predicate clauses is not stable and will
be changed, but the general idea will always stay the same.
<p>
Use this in your
<a href="structure/IStructureElement.html#survivalPlaceBlock(T,net.minecraft.world.World,int,int,int,net.minecraft.item.ItemStack,com.gtnewhorizon.structurelib.structure.AutoPlaceEnvironment)"><code>IStructureElement.survivalPlaceBlock(Object, World, int, int, int, ItemStack, AutoPlaceEnvironment)</code></a></div>
</li>
</ul>
<a id="isBlockTriviallyReplaceable(net.minecraft.world.World,int,int,int,net.minecraft.entity.player.EntityPlayer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBlockTriviallyReplaceable</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isBlockTriviallyReplaceable&#8203;(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html?is-external=true" title="class or interface in net.minecraft.world" class="externalLink">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayer</a>&nbsp;actor)</pre>
<div class="block">Determines if given block can be replaced without much effort. The exact predicate clauses is not stable and will
be changed, but the general idea will always stay the same.
<p>
Use this in your
<a href="structure/IStructureElement.html#survivalPlaceBlock(T,net.minecraft.world.World,int,int,int,net.minecraft.item.ItemStack,com.gtnewhorizon.structurelib.structure.AutoPlaceEnvironment)"><code>IStructureElement.survivalPlaceBlock(Object, World, int, int, int, ItemStack, AutoPlaceEnvironment)</code></a></div>
</li>
</ul>
<a id="addThrottledChat(java.lang.Object,net.minecraft.entity.player.EntityPlayer,net.minecraft.util.IChatComponent,short)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addThrottledChat</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;addThrottledChat&#8203;(java.lang.Object&nbsp;throttleKey,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayer</a>&nbsp;player,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/util/IChatComponent.html?is-external=true" title="class or interface in net.minecraft.util" class="externalLink">IChatComponent</a>&nbsp;text,
short&nbsp;intervalRequired)</pre>
<div class="block">Send chat to player, but throttled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>throttleKey</code> - throttle key. Must properly implement <code>Object.hashCode()</code> and
<code>Object.equals(Object)</code> to handle value equality.</dd>
<dd><code>player</code> - player to send chat to</dd>
<dd><code>text</code> - chat to send</dd>
<dd><code>intervalRequired</code> - interval required before last recorded time to actually send the message. unit in
millisecond. we purposefully chose to not use a bigger data type to limit how long this
interval can be</dd>
</dl>
</li>
</ul>
<a id="addThrottledChat(java.lang.Object,net.minecraft.entity.player.EntityPlayer,net.minecraft.util.IChatComponent,short,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addThrottledChat</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;addThrottledChat&#8203;(java.lang.Object&nbsp;throttleKey,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html?is-external=true" title="class or interface in net.minecraft.entity.player" class="externalLink">EntityPlayer</a>&nbsp;player,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/util/IChatComponent.html?is-external=true" title="class or interface in net.minecraft.util" class="externalLink">IChatComponent</a>&nbsp;text,
short&nbsp;intervalRequired,
boolean&nbsp;forceUpdateLastSend)</pre>
<div class="block">Send chat to player, but throttled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>throttleKey</code> - throttle key. Must properly implement <code>Object.hashCode()</code> and
<code>Object.equals(Object)</code> to handle value equality.</dd>
<dd><code>player</code> - player to send chat to</dd>
<dd><code>text</code> - chat to send</dd>
<dd><code>intervalRequired</code> - interval required before last recorded time to actually send the message. unit in
millisecond. we purposefully chose to not use a bigger data type to limit how long
this interval can be</dd>
<dd><code>forceUpdateLastSend</code> - if true, always update the last send time, even if the message isn't actually sent.</dd>
</dl>
</li>
</ul>
<a id="registerChannelDescription(java.lang.String,java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerChannelDescription</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;registerChannelDescription&#8203;(java.lang.String&nbsp;channel,
java.lang.String&nbsp;modid,
java.lang.String&nbsp;description)</pre>
<div class="block">Register a channel description here. The description should describe how a channel will be used inside your mod.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - channel key</dd>
<dd><code>modid</code> - your modid</dd>
<dd><code>description</code> - localization key for your description</dd>
</dl>
</li>
</ul>
<a id="registerChannelItem(java.lang.String,java.lang.String,int,net.minecraft.item.ItemStack)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>registerChannelItem</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;registerChannelItem&#8203;(java.lang.String&nbsp;channel,
java.lang.String&nbsp;modid,
int&nbsp;channelValue,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/item/ItemStack.html?is-external=true" title="class or interface in net.minecraft.item" class="externalLink">ItemStack</a>&nbsp;stack)</pre>
<div class="block">Register an item stack as an indicator for a (channel, value) pair.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - channel key</dd>
<dd><code>modid</code> - your modid</dd>
<dd><code>channelValue</code> - value</dd>
<dd><code>stack</code> - item stack. having a metadata of
<code>OreDictionary.WILDCARD_VALUE</code> will match without comparing
NBT or metadata value. having a tag with <code>tag.getBoolean("*") == true</code> will match
without comparing NBT.</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="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="../../../index.html?com/gtnewhorizon/structurelib/StructureLibAPI.html" target="_top">Frames</a></li>
<li><a href="StructureLibAPI.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>
</footer>
</body>
</html>