UNPKG

crmod-api

Version:

A dynamic mod/asset generator for Cosmic Reach

65 lines • 43.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
54
55
56
57
58
59
60
61
62
63
64
65
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BlockModel | 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="BlockModel.html">BlockModel</a></li></ul><h1>Class BlockModel</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Defines a block model within a <a href="Mod.html" class="tsd-kind-class">Mod</a>.</p> <p> BlockModel</p> </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#BlockModel">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">BlockModel</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/blockModel.js#L12">api/blockModel.js:12</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="BlockModel.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="BlockModel.html#cuboids" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cuboids</span></a> <a href="BlockModel.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a> <a href="BlockModel.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="BlockModel.html#addCuboid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Cuboid</span></a> <a href="BlockModel.html#addCuboids" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Cuboids</span></a> <a href="BlockModel.html#append" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>append</span></a> <a href="BlockModel.html#applyMatrixTransform" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Matrix<wbr/>Transform</span></a> <a href="BlockModel.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="BlockModel.html#getAllMaterials" 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/>All<wbr/>Materials</span></a> <a href="BlockModel.html#rotate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rotate</span></a> <a href="BlockModel.html#rotateCentered" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rotate<wbr/>Centered</span></a> <a href="BlockModel.html#scale" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>scale</span></a> <a href="BlockModel.html#scaleCentered" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>scale<wbr/>Centered</span></a> <a href="BlockModel.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> <a href="BlockModel.html#setAllMaterials" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>All<wbr/>Materials</span></a> <a href="BlockModel.html#setAmbientOcclusionEnabled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Ambient<wbr/>Occlusion<wbr/>Enabled</span></a> <a href="BlockModel.html#translate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>translate</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_BlockModel" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Block<wbr/>Model</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a><a href="#constructor.new_BlockModel" 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 BlockModel.</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">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</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/blockModel.js#L35">api/blockModel.js:35</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="cuboids" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cuboids</span><a href="#cuboids" 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">cuboids</span><span class="tsd-signature-symbol">:</span> <a href="ModelCuboid.html" class="tsd-signature-type tsd-kind-class">ModelCuboid</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The cuboids that make up the block model.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L27">api/blockModel.js:27</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name of the block model.</p> </div><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L19">api/blockModel.js:19</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="addCuboid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Cuboid</span><a href="#addCuboid" 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="addCuboid.addCuboid-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Cuboid</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cuboid</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a><a href="#addCuboid.addCuboid-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>Adds a cuboid to the block model.</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">cuboid</span>: <a href="ModelCuboid.html" class="tsd-signature-type tsd-kind-class">ModelCuboid</a></span><div class="tsd-comment tsd-typography"><p>The cuboid to add.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L84">api/blockModel.js:84</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addCuboids" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Cuboids</span><a href="#addCuboids" 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="addCuboids.addCuboids-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Cuboids</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">cuboids</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a><a href="#addCuboids.addCuboids-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>Adds multiple cuboids to the block model.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">cuboids</span>: <a href="ModelCuboid.html" class="tsd-signature-type tsd-kind-class">ModelCuboid</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The cuboids to add.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L96">api/blockModel.js:96</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="append" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>append</span><a href="#append" 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="append.append-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">append</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">other</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a><a href="#append.append-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>Appends the cuboid data from another BlockModel to current BlockModel.</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">other</span>: <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></span><div class="tsd-comment tsd-typography"><p>The BlockModel to append.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></h4><p>The current BlockModel.</p> <div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L130">api/blockModel.js:130</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="applyMatrixTransform" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>apply<wbr/>Matrix<wbr/>Transform</span><a href="#applyMatrixTransform" 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="applyMatrixTransform.applyMatrixTransform-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">apply<wbr/>Matrix<wbr/>Transform</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">matrix</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a><a href="#applyMatrixTransform.applyMatrixTransform-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>Applies a matrix transformation to the block model.</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">matrix</span>: <span class="tsd-signature-type">Matrix4</span></span><div class="tsd-comment tsd-typography"><p>The matrix transformation to apply.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L158">api/blockModel.js:158</a></li></ul></aside></li></ul></section><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">name</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</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 BlockModel into a new instance.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></h4><p>A new instance of the current BlockModel.</p> <div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L144">api/blockModel.js:144</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAllMaterials" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>All<wbr/>Materials</span><a href="#getAllMaterials" 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="getAllMaterials.getAllMaterials-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>All<wbr/>Materials</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Material.html" class="tsd-signature-type tsd-kind-class">Material</a><span class="tsd-signature-symbol">[]</span><a href="#getAllMaterials.getAllMaterials-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"><h4 class="tsd-returns-title">Returns <a href="Material.html" class="tsd-signature-type tsd-kind-class">Material</a><span class="tsd-signature-symbol">[]</span></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/blockModel.js#L115">api/blockModel.js:115</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rotate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>rotate</span><a href="#rotate" 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="rotate.rotate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">rotate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">euler</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a><a href="#rotate.rotate-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>Rotates the block model by the given euler angles.</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">euler</span>: <span class="tsd-signature-type">Euler</span></span><div class="tsd-comment tsd-typography"><p>The euler angles to rotate the block model by.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L183">api/blockModel.js:183</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rotateCentered" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>rotate<wbr/>Centered</span><a href="#rotateCentered" 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="rotateCentered.rotateCentered-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">rotate<wbr/>Centered</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">euler</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a><a href="#rotateCentered.rotateCentered-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>Rotates the block model around its center by the given euler angles.</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">euler</span>: <span class="tsd-signature-type">Euler</span></span><div class="tsd-comment tsd-typography"><p>The euler angles to rotate the block model by.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L205">api/blockModel.js:205</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="scale" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>scale</span><a href="#scale" 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="scale.scale-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">scale</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vector</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a><a href="#scale.scale-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>Scales the block model by the given vector.</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">vector</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The vector to scale the block model by.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L194">api/blockModel.js:194</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="scaleCentered" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>scale<wbr/>Centered</span><a href="#scaleCentered" 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="scaleCentered.scaleCentered-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">scale<wbr/>Centered</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vector</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a><a href="#scaleCentered.scaleCentered-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>Scales the block model around its center by the given vector.</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">vector</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L216">api/blockModel.js:216</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 model into a JSON object.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The serialized block model as a JSON object.</p> <div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</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/blockModel.js#L63">api/blockModel.js:63</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setAllMaterials" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>All<wbr/>Materials</span><a href="#setAllMaterials" 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="setAllMaterials.setAllMaterials-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>All<wbr/>Materials</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">material</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a><a href="#setAllMaterials.setAllMaterials-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>Sets the <a href="Material.html" class="tsd-kind-class">Material</a> for all cuboids in the block model.</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">material</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L108">api/blockModel.js:108</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setAmbientOcclusionEnabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Ambient<wbr/>Occlusion<wbr/>Enabled</span><a href="#setAmbientOcclusionEnabled" 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="setAmbientOcclusionEnabled.setAmbientOcclusionEnabled-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Ambient<wbr/>Occlusion<wbr/>Enabled</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">enableAmbientOcclusion</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setAmbientOcclusionEnabled.setAmbientOcclusionEnabled-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>Sets the ambient occlusion for the block model.</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">enableAmbientOcclusion</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Whether ambient occlusion is enabled.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L50">api/blockModel.js:50</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="translate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>translate</span><a href="#translate" 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="translate.translate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">translate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">offset</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a><a href="#translate.translate-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>Translates the block model by the given offset.</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">offset</span>: <span class="tsd-signature-type">Vector3</span></span><div class="tsd-comment tsd-typography"><p>The offset to translate the block model by.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BlockModel.html" class="tsd-signature-type tsd-kind-class">BlockModel</a></h4><div class="tsd-comment tsd-typography"><h4>Memberof</h4><p>BlockModel</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arlojay/cosmic-reach-modding-api/blob/bf2f84f/api/blockModel.js#L172">api/blockModel.js:172</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="#cuboids" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cuboids</span></a><a href="#name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</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="#addCuboid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Cuboid</span></a><a href="#addCuboids" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Cuboids</span></a><a href="#append" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>append</span></a><a href="#applyMatrixTransform" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Matrix<wbr/>Transform</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="#getAllMaterials" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>All<wbr/>Materials</span></a><a href="#rotate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rotate</span></a><a href="#rotateCentered" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rotate<wbr/>Centered</span></a><a href="#scale" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>scale</span></a><a href="#scaleCentered" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>scale<wbr/>Centered</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><a href="#setAllMaterials" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>All<wbr/>Materials</span></a><a href="#setAmbientOcclusionEnabled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Ambient<wbr/>Occlusion<wbr/>Enabled</span></a><a href="#translate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>translate</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>