UNPKG

crmod-api

Version:

A dynamic mod/asset generator for Cosmic Reach

39 lines • 26.6 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
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Block | 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="Block.html">Block</a></li></ul><h1>Class Block</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Defines a block within a <a href="Mod.html" class="tsd-kind-class">Mod</a>.</p> <p> Block</p> </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#Block">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="Writeable.html" class="tsd-signature-type tsd-kind-class">Writeable</a><ul class="tsd-hierarchy"><li><span class="target">Block</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/block.js#L13">api/block.js:13</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="Block.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="Block.html#defaultState" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>State</span></a> <a href="Block.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="Block.html#parentMod" 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/>Mod</span></a> <a href="Block.html#states" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>states</span></a> <a href="Block.html#written" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>written</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Block.html#createBlockState" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Block<wbr/>State</span></a> <a href="Block.html#getDefaultAsString" 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/>Default<wbr/>As<wbr/>String</span></a> <a href="Block.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="Block.html#getStringForState" 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/>String<wbr/>For<wbr/>State</span></a> <a href="Block.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_Block" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Block</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">parentMod</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Block.html" class="tsd-signature-type tsd-kind-class">Block</a><a href="#constructor.new_Block" 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 block.</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>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique id for this block.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">parentMod</span>: <a href="Mod.html" class="tsd-signature-type tsd-kind-class">Mod</a></span><div class="tsd-comment tsd-typography"><p>The <a href="Mod.html" class="tsd-kind-class">Mod</a> instance that contains this block.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Block.html" class="tsd-signature-type tsd-kind-class">Block</a></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Block</p> </div><aside class="tsd-sources"><p>Overrides <a href="Writeable.html">Writeable</a>.<a href="Writeable.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/block.js#L50">api/block.js:50</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="defaultState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>default<wbr/>State</span><a href="#defaultState" 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">default<wbr/>State</span><span class="tsd-signature-symbol">:</span> <a href="StateIdBase.html" class="tsd-signature-type tsd-kind-class">StateIdBase</a></div><div class="tsd-comment tsd-typography"><p>The default <a href="BlockState.html" class="tsd-kind-class">BlockState</a> for this block.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Block</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/block.js#L34">api/block.js:34</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> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The unique id for this block.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Block</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/block.js#L20">api/block.js:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="parentMod" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>parent<wbr/>Mod</span><a href="#parentMod" 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/>Mod</span><span class="tsd-signature-symbol">:</span> <a href="Mod.html" class="tsd-signature-type tsd-kind-class">Mod</a></div><div class="tsd-comment tsd-typography"><p>The <a href="Mod.html" class="tsd-kind-class">Mod</a> instance that contains this block.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Block</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/block.js#L27">api/block.js:27</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="states" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>states</span><a href="#states" 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">states</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>The list of <a href="BlockState.html" class="tsd-kind-class">BlockStates</a> for this block.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Block</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/block.js#L41">api/block.js:41</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="written" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>written</span><a href="#written" 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">written</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="Writeable.html">Writeable</a>.<a href="Writeable.html#written">written</a></p><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/writeable.js#L9">api/writeable.js:9</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="createBlockState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Block<wbr/>State</span><a href="#createBlockState" 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="createBlockState.createBlockState-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Block<wbr/>State</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span>, <span class="tsd-kind-parameter">settings</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="#createBlockState.createBlockState-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>Creates a new <a href="BlockState.html" class="tsd-kind-class">BlockState</a> for this block.</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">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 the state.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">settings</span>: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></span><ul class="tsd-parameters"></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockState.html" class="tsd-signature-type tsd-kind-class">BlockState</a></h4><p>The generated BlockState.</p> <div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Block</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/block.js#L67">api/block.js:67</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDefaultAsString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Default<wbr/>As<wbr/>String</span><a href="#getDefaultAsString" 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="getDefaultAsString.getDefaultAsString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Default<wbr/>As<wbr/>String</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="#getDefaultAsString.getDefaultAsString-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 identifier for the default <a href="BlockState.html" class="tsd-kind-class">BlockState</a> within this block.</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>Block</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/block.js#L89">api/block.js:89</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 within its parent <a href="Mod.html" class="tsd-kind-class">Mod</a>.</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>Block</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/block.js#L79">api/block.js:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStringForState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>String<wbr/>For<wbr/>State</span><a href="#getStringForState" 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="getStringForState.getStringForState-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>String<wbr/>For<wbr/>State</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getStringForState.getStringForState-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 identifier for a given <a href="BlockState.html" class="tsd-kind-class">BlockState</a> within this block.</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">state</span>: <a href="BlockState.html" class="tsd-signature-type tsd-kind-class">BlockState</a></span><div class="tsd-comment tsd-typography"><p>The <a href="BlockState.html" class="tsd-kind-class">BlockState</a> to get the identifier from.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></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>Block</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/block.js#L100">api/block.js:100</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 this block and returns it as a JSON object.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>Block</p> </div><aside class="tsd-sources"><p>Overrides <a href="Writeable.html">Writeable</a>.<a href="Writeable.html#serialize">serialize</a></p><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/block.js#L111">api/block.js:111</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="#defaultState" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>State</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="#parentMod" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent<wbr/>Mod</span></a><a href="#states" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>states</span></a><a href="#written" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>written</span></a><a href="#createBlockState" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Block<wbr/>State</span></a><a href="#getDefaultAsString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default<wbr/>As<wbr/>String</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="#getStringForState" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>String<wbr/>For<wbr/>State</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>