UNPKG

crmod-api

Version:

A dynamic mod/asset generator for Cosmic Reach

53 lines • 30.4 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BlockState | crmod-api</title><meta name="description" content="Documentation for crmod-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">crmod-api</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">crmod-api</a></li><li><a href="BlockState.html">BlockState</a></li></ul><h1>Class BlockState</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Defines a state for a <a href="Block.html" class="tsd-kind-class">Block</a>.</p> <p> BlockState</p> </div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L178">api/blockState.js:178</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="BlockState.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="BlockState.html#generateSlabs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>generate<wbr/>Slabs</span></a> <a href="BlockState.html#hidden" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden</span></a> <a href="BlockState.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a> <a href="BlockState.html#lightAttenuation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>light<wbr/>Attenuation</span></a> <a href="BlockState.html#lightLevelBlue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>light<wbr/>Level<wbr/>Blue</span></a> <a href="BlockState.html#lightLevelGreen" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>light<wbr/>Level<wbr/>Green</span></a> <a href="BlockState.html#lightLevelRed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>light<wbr/>Level<wbr/>Red</span></a> <a href="BlockState.html#model" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a> <a href="BlockState.html#opaque" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>opaque</span></a> <a href="BlockState.html#parentBlock" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent<wbr/>Block</span></a> <a href="BlockState.html#transparent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transparent</span></a> <a href="BlockState.html#triggerSheet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>trigger<wbr/>Sheet</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="BlockState.html#clone" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clone</span></a> <a href="BlockState.html#getFullId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Full<wbr/>Id</span></a> <a href="BlockState.html#serialize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>serialize</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_BlockState" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Block<wbr/>State</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">model</span>, <span class="tsd-kind-parameter">settings</span>, <span class="tsd-kind-parameter">parentBlock</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockState.html" class="tsd-signature-type tsd-kind-class">BlockState</a><a href="#constructor.new_BlockState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new BlockState.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="StateId.html" class="tsd-signature-type tsd-kind-class">StateId</a></span><div class="tsd-comment tsd-typography"><p>The id for this block state.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">model</span>: <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></span><div class="tsd-comment tsd-typography"><p>The model for this block state.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">settings</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The settings for this block state.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">parentBlock</span>: <a href="Block.html" class="tsd-signature-type tsd-kind-class">Block</a></span><div class="tsd-comment tsd-typography"><p>The parent block for this block state.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockState.html" class="tsd-signature-type tsd-kind-class">BlockState</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L283">api/blockState.js:283</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="generateSlabs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>generate<wbr/>Slabs</span><a href="#generateSlabs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">generate<wbr/>Slabs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether this block state generates slabs.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockState</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L241">api/blockState.js:241</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="hidden" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hidden</span><a href="#hidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hidden</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L301">api/blockState.js:301</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <a href="StateId.html" class="tsd-signature-type tsd-kind-class">StateId</a></div><div class="tsd-comment tsd-typography"><p>The id for this block state.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockState</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L185">api/blockState.js:185</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="lightAttenuation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>light<wbr/>Attenuation</span><a href="#lightAttenuation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">light<wbr/>Attenuation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The light attenuation for this block state.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockState</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L233">api/blockState.js:233</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="lightLevelBlue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>light<wbr/>Level<wbr/>Blue</span><a href="#lightLevelBlue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">light<wbr/>Level<wbr/>Blue</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The blue light level for this block state.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockState</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L265">api/blockState.js:265</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="lightLevelGreen" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>light<wbr/>Level<wbr/>Green</span><a href="#lightLevelGreen" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">light<wbr/>Level<wbr/>Green</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The green light level for this block state.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockState</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L257">api/blockState.js:257</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="lightLevelRed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>light<wbr/>Level<wbr/>Red</span><a href="#lightLevelRed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">light<wbr/>Level<wbr/>Red</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The red light level for this block state.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockState</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L249">api/blockState.js:249</a></li><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L273">api/blockState.js:273</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></div><div class="tsd-comment tsd-typography"><p>The model for this block state.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockState</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L201">api/blockState.js:201</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="opaque" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>opaque</span><a href="#opaque" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">opaque</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether this block state is opaque.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockState</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L217">api/blockState.js:217</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="parentBlock" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>parent<wbr/>Block</span><a href="#parentBlock" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">parent<wbr/>Block</span><span class="tsd-signature-symbol">:</span> <a href="Block.html" class="tsd-signature-type tsd-kind-class">Block</a></div><div class="tsd-comment tsd-typography"><p>The parent block for this block state.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockState</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L193">api/blockState.js:193</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transparent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transparent</span><a href="#transparent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transparent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether this block state is transparent.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockState</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L225">api/blockState.js:225</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="triggerSheet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>trigger<wbr/>Sheet</span><a href="#triggerSheet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">trigger<wbr/>Sheet</span><span class="tsd-signature-symbol">:</span> <a href="TriggerSheet.html" class="tsd-signature-type tsd-kind-class">TriggerSheet</a></div><div class="tsd-comment tsd-typography"><p>The trigger sheet for this block state.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockState</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L209">api/blockState.js:209</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="clone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clone</span><a href="#clone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="clone.clone-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clone</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockState.html" class="tsd-signature-type tsd-kind-class">BlockState</a><a href="#clone.clone-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clones the block state into a new instance.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="StateId.html" class="tsd-signature-type tsd-kind-class">StateId</a><span class="tsd-signature-symbol"> = ...</span></span><div class="tsd-comment tsd-typography"><p>The id for the new block state.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockState.html" class="tsd-signature-type tsd-kind-class">BlockState</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L310">api/blockState.js:310</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFullId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Full<wbr/>Id</span><a href="#getFullId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFullId.getFullId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Full<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFullId.getFullId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the full id for this block state.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockState</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L353">api/blockState.js:353</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="serialize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>serialize</span><a href="#serialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="serialize.serialize-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">serialize</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#serialize.serialize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Serializes the block state into a JSON object.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The serialized block state as a JSON object.</p> <div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockState</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockState.js#L331">api/blockState.js:331</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#generateSlabs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>generate<wbr/>Slabs</span></a><a href="#hidden" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#lightAttenuation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>light<wbr/>Attenuation</span></a><a href="#lightLevelBlue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>light<wbr/>Level<wbr/>Blue</span></a><a href="#lightLevelGreen" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>light<wbr/>Level<wbr/>Green</span></a><a href="#lightLevelRed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>light<wbr/>Level<wbr/>Red</span></a><a href="#model" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#opaque" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>opaque</span></a><a href="#parentBlock" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent<wbr/>Block</span></a><a href="#transparent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transparent</span></a><a href="#triggerSheet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>trigger<wbr/>Sheet</span></a><a href="#clone" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clone</span></a><a href="#getFullId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Full<wbr/>Id</span></a><a href="#serialize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>serialize</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>crmod-api</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html>