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

1227 lines
92 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (25) -->
<title>StructureLibAPI (StructureLib 1.4.42-master.1+137f651486 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: com.gtnewhorizon.structurelib, class: StructureLibAPI">
<meta name="generator" content="javadoc/ClassWriter">
<link rel="stylesheet" type="text/css" href="../../../resource-files/jquery-ui.min.css">
<link rel="stylesheet" type="text/css" href="../../../resource-files/stylesheet.css">
<script type="text/javascript" src="../../../script-files/script.js"></script>
<script type="text/javascript" src="../../../script-files/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../script-files/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">const pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="nav-content">
<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button></div>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../search.html">Search</a></li>
<li><a href="../../../help-doc.html#class">Help</a></li>
</ul>
</div>
</div>
<div class="sub-nav">
<div class="nav-content">
<ol class="sub-nav-list">
<li><a href="package-summary.html">com.gtnewhorizon.structurelib</a></li>
<li><a href="StructureLibAPI.html" class="current-selection">StructureLibAPI</a></li>
</ol>
<div class="nav-list-search"><input type="text" id="search-input" disabled placeholder="Search documentation (type /)" aria-label="Search in documentation" autocomplete="off" spellcheck="false"><input type="reset" id="reset-search" disabled value="Reset"></div>
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="main-grid">
<nav role="navigation" class="toc" aria-label="Table of contents">
<div class="toc-header">Contents&nbsp;<input type="text" class="filter-input" disabled placeholder="Filter contents (type .)" aria-label="Filter table of contents" autocomplete="off" spellcheck="false"><input type="reset" class="reset-filter" disabled tabindex="-1" value="Reset"></div>
<ol class="toc-list" tabindex="-1">
<li><a href="#" tabindex="0">Description</a></li>
<li><a href="#field-summary" tabindex="0">Field Summary</a></li>
<li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li>
<li><a href="#method-summary" tabindex="0">Method Summary</a></li>
<li><a href="#field-detail" tabindex="0">Field Details</a>
<ol class="toc-list">
<li><a href="#MOD_ID" tabindex="0">MOD_ID</a></li>
<li><a href="#HINT_BLOCK_META_GENERIC_0" tabindex="0">HINT_BLOCK_META_GENERIC_0</a></li>
<li><a href="#HINT_BLOCK_META_GENERIC_1" tabindex="0">HINT_BLOCK_META_GENERIC_1</a></li>
<li><a href="#HINT_BLOCK_META_GENERIC_2" tabindex="0">HINT_BLOCK_META_GENERIC_2</a></li>
<li><a href="#HINT_BLOCK_META_GENERIC_3" tabindex="0">HINT_BLOCK_META_GENERIC_3</a></li>
<li><a href="#HINT_BLOCK_META_GENERIC_4" tabindex="0">HINT_BLOCK_META_GENERIC_4</a></li>
<li><a href="#HINT_BLOCK_META_GENERIC_5" tabindex="0">HINT_BLOCK_META_GENERIC_5</a></li>
<li><a href="#HINT_BLOCK_META_GENERIC_6" tabindex="0">HINT_BLOCK_META_GENERIC_6</a></li>
<li><a href="#HINT_BLOCK_META_GENERIC_7" tabindex="0">HINT_BLOCK_META_GENERIC_7</a></li>
<li><a href="#HINT_BLOCK_META_GENERIC_8" tabindex="0">HINT_BLOCK_META_GENERIC_8</a></li>
<li><a href="#HINT_BLOCK_META_GENERIC_9" tabindex="0">HINT_BLOCK_META_GENERIC_9</a></li>
<li><a href="#HINT_BLOCK_META_GENERIC_10" tabindex="0">HINT_BLOCK_META_GENERIC_10</a></li>
<li><a href="#HINT_BLOCK_META_GENERIC_11" tabindex="0">HINT_BLOCK_META_GENERIC_11</a></li>
<li><a href="#HINT_BLOCK_META_DEFAULT" tabindex="0">HINT_BLOCK_META_DEFAULT</a></li>
<li><a href="#HINT_BLOCK_META_AIR" tabindex="0">HINT_BLOCK_META_AIR</a></li>
<li><a href="#HINT_BLOCK_META_NOT_AIR" tabindex="0">HINT_BLOCK_META_NOT_AIR</a></li>
<li><a href="#HINT_BLOCK_META_ERROR" tabindex="0">HINT_BLOCK_META_ERROR</a></li>
<li><a href="#CHANNEL_SHOW_ERROR" tabindex="0">CHANNEL_SHOW_ERROR</a></li>
</ol>
</li>
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
<ol class="toc-list">
<li><a href="#%3Cinit%3E()" tabindex="0">StructureLibAPI()</a></li>
</ol>
</li>
<li><a href="#method-detail" tabindex="0">Method Details</a>
<ol class="toc-list">
<li><a href="#enableInstrument(java.lang.Object)" tabindex="0">enableInstrument(Object)</a></li>
<li><a href="#disableInstrument()" tabindex="0">disableInstrument()</a></li>
<li><a href="#isInstrumentEnabled()" tabindex="0">isInstrumentEnabled()</a></li>
<li><a href="#startHinting(net.minecraft.world.World)" tabindex="0">startHinting(World)</a></li>
<li><a href="#endHinting(net.minecraft.world.World)" tabindex="0">endHinting(World)</a></li>
<li><a href="#hintParticleTinted(net.minecraft.world.World,int,int,int,net.minecraft.util.IIcon%5B%5D,short%5B%5D)" tabindex="0">hintParticleTinted(World, int, int, int, IIcon[], short[])</a></li>
<li><a href="#hintParticleTinted(net.minecraft.world.World,int,int,int,net.minecraft.block.Block,int,short%5B%5D)" tabindex="0">hintParticleTinted(World, int, int, int, Block, int, short[])</a></li>
<li><a href="#hintParticle(net.minecraft.world.World,int,int,int,net.minecraft.util.IIcon%5B%5D)" tabindex="0">hintParticle(World, int, int, int, IIcon[])</a></li>
<li><a href="#hintParticle(net.minecraft.world.World,int,int,int,net.minecraft.block.Block,int)" tabindex="0">hintParticle(World, int, int, int, Block, int)</a></li>
<li><a href="#markHintParticleError(net.minecraft.entity.player.EntityPlayer,net.minecraft.world.World,int,int,int)" tabindex="0">markHintParticleError(EntityPlayer, World, int, int, int)</a></li>
<li><a href="#updateHintParticleTint(net.minecraft.entity.player.EntityPlayer,net.minecraft.world.World,int,int,int,short%5B%5D)" tabindex="0">updateHintParticleTint(EntityPlayer, World, int, int, int, short[])</a></li>
<li><a href="#queryAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider)" tabindex="0">queryAlignment(IAlignmentProvider)</a></li>
<li><a href="#sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider)" tabindex="0">sendAlignment(IAlignmentProvider)</a></li>
<li><a href="#sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,net.minecraft.entity.player.EntityPlayerMP)" tabindex="0">sendAlignment(IAlignmentProvider, EntityPlayerMP)</a></li>
<li><a href="#sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,cpw.mods.fml.common.network.NetworkRegistry.TargetPoint)" tabindex="0">sendAlignment(IAlignmentProvider, NetworkRegistry.TargetPoint)</a></li>
<li><a href="#sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,net.minecraft.world.World)" tabindex="0">sendAlignment(IAlignmentProvider, World)</a></li>
<li><a href="#getBlockHint()" tabindex="0">getBlockHint()</a></li>
<li><a href="#getItemBlockHint()" tabindex="0">getItemBlockHint()</a></li>
<li><a href="#getDefaultHologramItem()" tabindex="0">getDefaultHologramItem()</a></li>
<li><a href="#isDebugEnabled()" tabindex="0">isDebugEnabled()</a></li>
<li><a href="#setDebugEnabled(boolean)" tabindex="0">setDebugEnabled(boolean)</a></li>
<li><a href="#isBlockTriviallyReplaceable(net.minecraft.world.World,int,int,int,net.minecraft.entity.player.EntityPlayerMP)" tabindex="0">isBlockTriviallyReplaceable(World, int, int, int, EntityPlayerMP)</a></li>
<li><a href="#isBlockTriviallyReplaceable(net.minecraft.world.World,int,int,int,net.minecraft.entity.player.EntityPlayer)" tabindex="0">isBlockTriviallyReplaceable(World, int, int, int, EntityPlayer)</a></li>
<li><a href="#addThrottledChat(java.lang.Object,net.minecraft.entity.player.EntityPlayer,net.minecraft.util.IChatComponent,short)" tabindex="0">addThrottledChat(Object, EntityPlayer, IChatComponent, short)</a></li>
<li><a href="#addThrottledChat(java.lang.Object,net.minecraft.entity.player.EntityPlayer,net.minecraft.util.IChatComponent,short,boolean)" tabindex="0">addThrottledChat(Object, EntityPlayer, IChatComponent, short, boolean)</a></li>
<li><a href="#registerChannelDescription(java.lang.String,java.lang.String,java.lang.String)" tabindex="0">registerChannelDescription(String, String, String)</a></li>
<li><a href="#registerChannelItem(java.lang.String,java.lang.String,int,net.minecraft.item.ItemStack)" tabindex="0">registerChannelItem(String, String, int, ItemStack)</a></li>
</ol>
</li>
</ol>
<button class="hide-sidebar"><span>Hide sidebar&nbsp;</span><img src="../../../resource-files/left.svg" alt="Hide sidebar"></button><button class="show-sidebar"><img src="../../../resource-files/right.svg" alt="Show sidebar"><span>&nbsp;Show sidebar</span></button></nav>
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<h1 title="Class StructureLibAPI" class="title">Class StructureLibAPI</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">com.gtnewhorizon.structurelib.StructureLibAPI</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="horizontal-scroll">
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">StructureLibAPI</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">A stable interface into the structure lib's internals. Backwards compatibility is maintained to the maximum extend
possible.</div>
</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#CHANNEL_SHOW_ERROR" class="member-name-link">CHANNEL_SHOW_ERROR</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#HINT_BLOCK_META_AIR" class="member-name-link">HINT_BLOCK_META_AIR</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#HINT_BLOCK_META_DEFAULT" class="member-name-link">HINT_BLOCK_META_DEFAULT</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#HINT_BLOCK_META_ERROR" class="member-name-link">HINT_BLOCK_META_ERROR</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#HINT_BLOCK_META_GENERIC_0" class="member-name-link">HINT_BLOCK_META_GENERIC_0</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#HINT_BLOCK_META_GENERIC_1" class="member-name-link">HINT_BLOCK_META_GENERIC_1</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#HINT_BLOCK_META_GENERIC_10" class="member-name-link">HINT_BLOCK_META_GENERIC_10</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#HINT_BLOCK_META_GENERIC_11" class="member-name-link">HINT_BLOCK_META_GENERIC_11</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#HINT_BLOCK_META_GENERIC_2" class="member-name-link">HINT_BLOCK_META_GENERIC_2</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#HINT_BLOCK_META_GENERIC_3" class="member-name-link">HINT_BLOCK_META_GENERIC_3</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#HINT_BLOCK_META_GENERIC_4" class="member-name-link">HINT_BLOCK_META_GENERIC_4</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#HINT_BLOCK_META_GENERIC_5" class="member-name-link">HINT_BLOCK_META_GENERIC_5</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#HINT_BLOCK_META_GENERIC_6" class="member-name-link">HINT_BLOCK_META_GENERIC_6</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#HINT_BLOCK_META_GENERIC_7" class="member-name-link">HINT_BLOCK_META_GENERIC_7</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#HINT_BLOCK_META_GENERIC_8" class="member-name-link">HINT_BLOCK_META_GENERIC_8</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#HINT_BLOCK_META_GENERIC_9" class="member-name-link">HINT_BLOCK_META_GENERIC_9</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#HINT_BLOCK_META_NOT_AIR" class="member-name-link">HINT_BLOCK_META_NOT_AIR</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#MOD_ID" class="member-name-link">MOD_ID</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">StructureLibAPI</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#addThrottledChat(java.lang.Object,net.minecraft.entity.player.EntityPlayer,net.minecraft.util.IChatComponent,short)" class="member-name-link">addThrottledChat</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;throttleKey,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html" title="class or interface in net.minecraft.entity.player" class="external-link">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" title="class or interface in net.minecraft.util" class="external-link">IChatComponent</a>&nbsp;text,
short&nbsp;intervalRequired)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Send chat to player, but throttled.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#addThrottledChat(java.lang.Object,net.minecraft.entity.player.EntityPlayer,net.minecraft.util.IChatComponent,short,boolean)" class="member-name-link">addThrottledChat</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;throttleKey,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html" title="class or interface in net.minecraft.entity.player" class="external-link">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" title="class or interface in net.minecraft.util" class="external-link">IChatComponent</a>&nbsp;text,
short&nbsp;intervalRequired,
boolean&nbsp;forceUpdateLastSend)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Send chat to player, but throttled.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#disableInstrument()" class="member-name-link">disableInstrument</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Stop instrumenting.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#enableInstrument(java.lang.Object)" class="member-name-link">enableInstrument</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;identifier)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Start instrumenting <b>for the current thread only</b>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#endHinting(net.minecraft.world.World)" class="member-name-link">endHinting</a><wbr>(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">World</a>&nbsp;w)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">End current batch of hinting.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/block/Block.html" title="class or interface in net.minecraft.block" class="external-link">Block</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getBlockHint()" class="member-name-link">getBlockHint</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Get the Block for StructureLib supplied hint block.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/item/Item.html" title="class or interface in net.minecraft.item" class="external-link">Item</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDefaultHologramItem()" class="member-name-link">getDefaultHologramItem</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Get the hologram item.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/item/Item.html" title="class or interface in net.minecraft.item" class="external-link">Item</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getItemBlockHint()" class="member-name-link">getItemBlockHint</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Get the ItemBlock for StructureLib supplied hint block.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hintParticle(net.minecraft.world.World,int,int,int,net.minecraft.block.Block,int)" class="member-name-link">hintParticle</a><wbr>(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">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" title="class or interface in net.minecraft.block" class="external-link">Block</a>&nbsp;block,
int&nbsp;meta)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Generate a new hint particle on client side at given location using textures from given block.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hintParticle(net.minecraft.world.World,int,int,int,net.minecraft.util.IIcon%5B%5D)" class="member-name-link">hintParticle</a><wbr>(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">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" title="class or interface in net.minecraft.util" class="external-link">IIcon</a>[]&nbsp;icons)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Generate a new hint particle on client side at given location using given textures.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hintParticleTinted(net.minecraft.world.World,int,int,int,net.minecraft.block.Block,int,short%5B%5D)" class="member-name-link">hintParticleTinted</a><wbr>(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">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" title="class or interface in net.minecraft.block" class="external-link">Block</a>&nbsp;block,
int&nbsp;meta,
short[]&nbsp;RGBa)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Generate a new hint particle on client side at given location using textures from given block with a tint.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hintParticleTinted(net.minecraft.world.World,int,int,int,net.minecraft.util.IIcon%5B%5D,short%5B%5D)" class="member-name-link">hintParticleTinted</a><wbr>(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">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" title="class or interface in net.minecraft.util" class="external-link">IIcon</a>[]&nbsp;icons,
short[]&nbsp;RGBa)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Generate a new hint particle on client side at given location using given textures with a tint.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isBlockTriviallyReplaceable(net.minecraft.world.World,int,int,int,net.minecraft.entity.player.EntityPlayer)" class="member-name-link">isBlockTriviallyReplaceable</a><wbr>(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">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" title="class or interface in net.minecraft.entity.player" class="external-link">EntityPlayer</a>&nbsp;actor)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Determines if given block can be replaced without much effort.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isBlockTriviallyReplaceable(net.minecraft.world.World,int,int,int,net.minecraft.entity.player.EntityPlayerMP)" class="member-name-link">isBlockTriviallyReplaceable</a><wbr>(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">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" title="class or interface in net.minecraft.entity.player" class="external-link">EntityPlayerMP</a>&nbsp;actor)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isDebugEnabled()" class="member-name-link">isDebugEnabled</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Check if structure debug mode is on.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isInstrumentEnabled()" class="member-name-link">isInstrumentEnabled</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Check if instrumenting is enabled.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#markHintParticleError(net.minecraft.entity.player.EntityPlayer,net.minecraft.world.World,int,int,int)" class="member-name-link">markHintParticleError</a><wbr>(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html" title="class or interface in net.minecraft.entity.player" class="external-link">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" title="class or interface in net.minecraft.world" class="external-link">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Update the tint of given hint particle.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#queryAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider)" class="member-name-link">queryAlignment</a><wbr>(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Query the ExtendedFacing of this tile entity from client side.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#registerChannelDescription(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">registerChannelDescription</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;channel,
<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;modid,
<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;description)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Register a channel description here.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#registerChannelItem(java.lang.String,java.lang.String,int,net.minecraft.item.ItemStack)" class="member-name-link">registerChannelItem</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;channel,
<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&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" title="class or interface in net.minecraft.item" class="external-link">ItemStack</a>&nbsp;stack)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Register an item stack as an indicator for a (channel, value) pair.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider)" class="member-name-link">sendAlignment</a><wbr>(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Send the ExtendedFacing of this Tile Entity to all players.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,cpw.mods.fml.common.network.NetworkRegistry.TargetPoint)" class="member-name-link">sendAlignment</a><wbr>(<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" title="class or interface in cpw.mods.fml.common.network" class="external-link">NetworkRegistry.TargetPoint</a>&nbsp;targetPoint)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Send the ExtendedFacing of this Tile Entity to all players around target point.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,net.minecraft.entity.player.EntityPlayerMP)" class="member-name-link">sendAlignment</a><wbr>(<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" title="class or interface in net.minecraft.entity.player" class="external-link">EntityPlayerMP</a>&nbsp;player)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Send the ExtendedFacing of this Tile Entity to given player.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,net.minecraft.world.World)" class="member-name-link">sendAlignment</a><wbr>(<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" title="class or interface in net.minecraft.world" class="external-link">World</a>&nbsp;dimension)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Send the ExtendedFacing of this Tile Entity to all players in that dimension.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setDebugEnabled(boolean)" class="member-name-link">setDebugEnabled</a><wbr>(boolean&nbsp;enabled)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#startHinting(net.minecraft.world.World)" class="member-name-link">startHinting</a><wbr>(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">World</a>&nbsp;w)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Start a batch of hinting.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#updateHintParticleTint(net.minecraft.entity.player.EntityPlayer,net.minecraft.world.World,int,int,int,short%5B%5D)" class="member-name-link">updateHintParticleTint</a><wbr>(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html" title="class or interface in net.minecraft.entity.player" class="external-link">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" title="class or interface in net.minecraft.world" class="external-link">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
short[]&nbsp;RGBa)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Update the tint of given hint particle.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#method-summary" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="MOD_ID">
<h3>MOD_ID</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">MOD_ID</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.MOD_ID">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_GENERIC_0">
<h3>HINT_BLOCK_META_GENERIC_0</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_GENERIC_0</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_0">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_GENERIC_1">
<h3>HINT_BLOCK_META_GENERIC_1</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_GENERIC_1</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_1">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_GENERIC_2">
<h3>HINT_BLOCK_META_GENERIC_2</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_GENERIC_2</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_2">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_GENERIC_3">
<h3>HINT_BLOCK_META_GENERIC_3</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_GENERIC_3</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_3">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_GENERIC_4">
<h3>HINT_BLOCK_META_GENERIC_4</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_GENERIC_4</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_4">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_GENERIC_5">
<h3>HINT_BLOCK_META_GENERIC_5</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_GENERIC_5</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_5">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_GENERIC_6">
<h3>HINT_BLOCK_META_GENERIC_6</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_GENERIC_6</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_6">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_GENERIC_7">
<h3>HINT_BLOCK_META_GENERIC_7</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_GENERIC_7</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_7">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_GENERIC_8">
<h3>HINT_BLOCK_META_GENERIC_8</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_GENERIC_8</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_8">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_GENERIC_9">
<h3>HINT_BLOCK_META_GENERIC_9</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_GENERIC_9</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_9">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_GENERIC_10">
<h3>HINT_BLOCK_META_GENERIC_10</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_GENERIC_10</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_10">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_GENERIC_11">
<h3>HINT_BLOCK_META_GENERIC_11</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_GENERIC_11</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_GENERIC_11">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_DEFAULT">
<h3>HINT_BLOCK_META_DEFAULT</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_DEFAULT</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_DEFAULT">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_AIR">
<h3>HINT_BLOCK_META_AIR</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_AIR</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_AIR">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_NOT_AIR">
<h3>HINT_BLOCK_META_NOT_AIR</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_NOT_AIR</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_NOT_AIR">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="HINT_BLOCK_META_ERROR">
<h3>HINT_BLOCK_META_ERROR</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">HINT_BLOCK_META_ERROR</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.HINT_BLOCK_META_ERROR">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="CHANNEL_SHOW_ERROR">
<h3>CHANNEL_SHOW_ERROR</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">CHANNEL_SHOW_ERROR</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../constant-values.html#com.gtnewhorizon.structurelib.StructureLibAPI.CHANNEL_SHOW_ERROR">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>StructureLibAPI</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">StructureLibAPI</span>()</div>
</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="enableInstrument(java.lang.Object)">
<h3>enableInstrument</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">enableInstrument</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;identifier)</span></div>
<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 <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link"><code>Object.equals(Object)</code></a>. 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" title="class or interface in cpw.mods.fml.common" class="external-link"><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" title="class or interface in net.minecraft.util" class="external-link"><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 class="notes">
<dt>Parameters:</dt>
<dd><code>identifier</code> - an identifier sent along the actual event.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if instrument has already been enabled.</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="disableInstrument()">
<h3>disableInstrument</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">disableInstrument</span>()</div>
<div class="block">Stop instrumenting.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if instrumenting hasn't been enabled.</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="isInstrumentEnabled()">
<h3>isInstrumentEnabled</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isInstrumentEnabled</span>()</div>
<div class="block">Check if instrumenting is enabled.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if enabled, false otherwise</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="startHinting(net.minecraft.world.World)">
<h3>startHinting</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">startHinting</span><wbr><span class="parameters">(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">World</a>&nbsp;w)</span></div>
<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>
</div>
</section>
</li>
<li>
<section class="detail" id="endHinting(net.minecraft.world.World)">
<h3>endHinting</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">endHinting</span><wbr><span class="parameters">(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">World</a>&nbsp;w)</span></div>
<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>
</div>
</section>
</li>
<li>
<section class="detail" id="hintParticleTinted(net.minecraft.world.World,int,int,int,net.minecraft.util.IIcon[],short[])">
<h3>hintParticleTinted</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">hintParticleTinted</span><wbr><span class="parameters">(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">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" title="class or interface in net.minecraft.util" class="external-link">IIcon</a>[]&nbsp;icons,
short[]&nbsp;RGBa)</span></div>
<div class="block">Generate a new hint particle on client side at given location using given textures with a tint.</div>
<dl class="notes">
<dt>Parameters:</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>
</div>
</section>
</li>
<li>
<section class="detail" id="hintParticleTinted(net.minecraft.world.World,int,int,int,net.minecraft.block.Block,int,short[])">
<h3>hintParticleTinted</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">hintParticleTinted</span><wbr><span class="parameters">(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">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" title="class or interface in net.minecraft.block" class="external-link">Block</a>&nbsp;block,
int&nbsp;meta,
short[]&nbsp;RGBa)</span></div>
<div class="block">Generate a new hint particle on client side at given location using textures from given block with a tint.</div>
<dl class="notes">
<dt>Parameters:</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>
</div>
</section>
</li>
<li>
<section class="detail" id="hintParticle(net.minecraft.world.World,int,int,int,net.minecraft.util.IIcon[])">
<h3>hintParticle</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">hintParticle</span><wbr><span class="parameters">(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">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" title="class or interface in net.minecraft.util" class="external-link">IIcon</a>[]&nbsp;icons)</span></div>
<div class="block">Generate a new hint particle on client side at given location using given textures.</div>
<dl class="notes">
<dt>Parameters:</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>
</div>
</section>
</li>
<li>
<section class="detail" id="hintParticle(net.minecraft.world.World,int,int,int,net.minecraft.block.Block,int)">
<h3>hintParticle</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">hintParticle</span><wbr><span class="parameters">(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">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" title="class or interface in net.minecraft.block" class="external-link">Block</a>&nbsp;block,
int&nbsp;meta)</span></div>
<div class="block">Generate a new hint particle on client side at given location using textures from given block.</div>
<dl class="notes">
<dt>Parameters:</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>
</div>
</section>
</li>
<li>
<section class="detail" id="markHintParticleError(net.minecraft.entity.player.EntityPlayer,net.minecraft.world.World,int,int,int)">
<h3>markHintParticleError</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">markHintParticleError</span><wbr><span class="parameters">(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html" title="class or interface in net.minecraft.entity.player" class="external-link">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" title="class or interface in net.minecraft.world" class="external-link">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z)</span></div>
<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 class="notes">
<dt>Returns:</dt>
<dd>false if nothing updated. true if updated or update instruction sent.</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="updateHintParticleTint(net.minecraft.entity.player.EntityPlayer,net.minecraft.world.World,int,int,int,short[])">
<h3>updateHintParticleTint</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">updateHintParticleTint</span><wbr><span class="parameters">(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html" title="class or interface in net.minecraft.entity.player" class="external-link">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" title="class or interface in net.minecraft.world" class="external-link">World</a>&nbsp;w,
int&nbsp;x,
int&nbsp;y,
int&nbsp;z,
short[]&nbsp;RGBa)</span></div>
<div class="block">Update the tint of given hint particle. Do nothing if particle not found.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>false if nothing updated. true if updated.</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="queryAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider)">
<h3>queryAlignment</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">queryAlignment</span><wbr><span class="parameters">(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider)</span></div>
<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 class 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 class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if is not tile entity or provided a null alignment</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider)">
<h3>sendAlignment</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">sendAlignment</span><wbr><span class="parameters">(<a href="alignment/IAlignmentProvider.html" title="interface in com.gtnewhorizon.structurelib.alignment">IAlignmentProvider</a>&nbsp;provider)</span></div>
<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 class 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 class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if is not tile entity or provided a null alignment</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,net.minecraft.entity.player.EntityPlayerMP)">
<h3>sendAlignment</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">sendAlignment</span><wbr><span class="parameters">(<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" title="class or interface in net.minecraft.entity.player" class="external-link">EntityPlayerMP</a>&nbsp;player)</span></div>
<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 class 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 class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if is not tile entity or provided a null alignment</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,cpw.mods.fml.common.network.NetworkRegistry.TargetPoint)">
<h3>sendAlignment</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">sendAlignment</span><wbr><span class="parameters">(<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" title="class or interface in cpw.mods.fml.common.network" class="external-link">NetworkRegistry.TargetPoint</a>&nbsp;targetPoint)</span></div>
<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 class 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 class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if is not tile entity or provided a null alignment</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="sendAlignment(com.gtnewhorizon.structurelib.alignment.IAlignmentProvider,net.minecraft.world.World)">
<h3>sendAlignment</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">sendAlignment</span><wbr><span class="parameters">(<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" title="class or interface in net.minecraft.world" class="external-link">World</a>&nbsp;dimension)</span></div>
<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 class 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 class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if is not tile entity or provided a null alignment</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="getBlockHint()">
<h3>getBlockHint</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/block/Block.html" title="class or interface in net.minecraft.block" class="external-link">Block</a></span>&nbsp;<span class="element-name">getBlockHint</span>()</div>
<div class="block">Get the Block for StructureLib supplied hint block.</div>
</div>
</section>
</li>
<li>
<section class="detail" id="getItemBlockHint()">
<h3>getItemBlockHint</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/item/Item.html" title="class or interface in net.minecraft.item" class="external-link">Item</a></span>&nbsp;<span class="element-name">getItemBlockHint</span>()</div>
<div class="block">Get the ItemBlock for StructureLib supplied hint block.</div>
</div>
</section>
</li>
<li>
<section class="detail" id="getDefaultHologramItem()">
<h3>getDefaultHologramItem</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/item/Item.html" title="class or interface in net.minecraft.item" class="external-link">Item</a></span>&nbsp;<span class="element-name">getDefaultHologramItem</span>()</div>
<div class="block">Get the hologram item.</div>
</div>
</section>
</li>
<li>
<section class="detail" id="isDebugEnabled()">
<h3>isDebugEnabled</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isDebugEnabled</span>()</div>
<div class="block">Check if structure debug mode is on.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if debug mode is on</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="setDebugEnabled(boolean)">
<h3>setDebugEnabled</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setDebugEnabled</span><wbr><span class="parameters">(boolean&nbsp;enabled)</span></div>
</div>
</section>
</li>
<li>
<section class="detail" id="isBlockTriviallyReplaceable(net.minecraft.world.World,int,int,int,net.minecraft.entity.player.EntityPlayerMP)">
<h3>isBlockTriviallyReplaceable</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isBlockTriviallyReplaceable</span><wbr><span class="parameters">(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">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" title="class or interface in net.minecraft.entity.player" class="external-link">EntityPlayerMP</a>&nbsp;actor)</span></div>
<div class="deprecation-block"><span class="deprecated-label">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>
</div>
</section>
</li>
<li>
<section class="detail" id="isBlockTriviallyReplaceable(net.minecraft.world.World,int,int,int,net.minecraft.entity.player.EntityPlayer)">
<h3>isBlockTriviallyReplaceable</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isBlockTriviallyReplaceable</span><wbr><span class="parameters">(<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/world/World.html" title="class or interface in net.minecraft.world" class="external-link">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" title="class or interface in net.minecraft.entity.player" class="external-link">EntityPlayer</a>&nbsp;actor)</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>
</div>
</section>
</li>
<li>
<section class="detail" id="addThrottledChat(java.lang.Object,net.minecraft.entity.player.EntityPlayer,net.minecraft.util.IChatComponent,short)">
<h3>addThrottledChat</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addThrottledChat</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;throttleKey,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html" title="class or interface in net.minecraft.entity.player" class="external-link">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" title="class or interface in net.minecraft.util" class="external-link">IChatComponent</a>&nbsp;text,
short&nbsp;intervalRequired)</span></div>
<div class="block">Send chat to player, but throttled.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>throttleKey</code> - throttle key. Must properly implement <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link"><code>Object.hashCode()</code></a> and
<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link"><code>Object.equals(Object)</code></a> 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>
</div>
</section>
</li>
<li>
<section class="detail" id="addThrottledChat(java.lang.Object,net.minecraft.entity.player.EntityPlayer,net.minecraft.util.IChatComponent,short,boolean)">
<h3>addThrottledChat</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addThrottledChat</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;throttleKey,
<a href="https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/net/minecraft/entity/player/EntityPlayer.html" title="class or interface in net.minecraft.entity.player" class="external-link">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" title="class or interface in net.minecraft.util" class="external-link">IChatComponent</a>&nbsp;text,
short&nbsp;intervalRequired,
boolean&nbsp;forceUpdateLastSend)</span></div>
<div class="block">Send chat to player, but throttled.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>throttleKey</code> - throttle key. Must properly implement <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link"><code>Object.hashCode()</code></a> and
<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link"><code>Object.equals(Object)</code></a> 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>
</div>
</section>
</li>
<li>
<section class="detail" id="registerChannelDescription(java.lang.String,java.lang.String,java.lang.String)">
<h3>registerChannelDescription</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">registerChannelDescription</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;channel,
<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;modid,
<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;description)</span></div>
<div class="block">Register a channel description here. The description should describe how a channel will be used inside your mod.</div>
<dl class="notes">
<dt>Parameters:</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>
</div>
</section>
</li>
<li>
<section class="detail" id="registerChannelItem(java.lang.String,java.lang.String,int,net.minecraft.item.ItemStack)">
<h3>registerChannelItem</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">registerChannelItem</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;channel,
<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&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" title="class or interface in net.minecraft.item" class="external-link">ItemStack</a>&nbsp;stack)</span></div>
<div class="block">Register an item stack as an indicator for a (channel, value) pair.</div>
<dl class="notes">
<dt>Parameters:</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>
</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</body>
</html>