mirror of
https://github.com/huderlem/porymap.git
synced 2026-08-26 10:35:55 -05:00
Update manual
This commit is contained in:
GriffinR
@@ -250,147 +250,153 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">6.1.0 - 2025-06-09</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">6.2.0 - 2025-08-08</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">6.0.0 - 2025-05-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">6.1.0 - 2025-06-09</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">5.4.1 - 2024-03-21</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">6.0.0 - 2025-05-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">5.4.0 - 2024-02-13</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id10">5.4.1 - 2024-03-21</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id12">5.3.0 - 2024-01-15</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id12">5.4.0 - 2024-02-13</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">5.2.0 - 2024-01-02</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">5.3.0 - 2024-01-15</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">5.1.1 - 2023-02-20</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">5.2.0 - 2024-01-02</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id24">5.1.0 - 2023-01-22</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id24">5.1.1 - 2023-02-20</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">5.0.0 - 2022-10-30</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">5.1.0 - 2023-01-22</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">4.5.0 - 2021-12-26</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id32">5.0.0 - 2022-10-30</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id33">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id37">4.4.0 - 2020-12-20</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id37">4.5.0 - 2021-12-26</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id38">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id39">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id40">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id41">4.3.1 - 2020-07-17</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id41">4.4.0 - 2020-12-20</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id42">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id43">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id45">4.3.0 - 2020-06-27</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id45">4.3.1 - 2020-07-17</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id46">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id47">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id49">4.2.0 - 2020-06-06</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id49">4.3.0 - 2020-06-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id50">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id53">4.1.0 - 2020-05-18</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id53">4.2.0 - 2020-06-06</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id54">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id55">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id56">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id57">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id58">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id59">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id60">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id61">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id57">4.1.0 - 2020-05-18</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id58">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id59">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id60">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id62">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id63">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id61">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id62">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id63">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id64">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id65">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id64">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id65">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id66">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id67">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id68">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id66">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id67">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id69">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id70">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id71">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id72">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id73">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id68">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id69">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id70">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id71">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id72">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id74">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id73">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id74">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id75">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id76">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id77">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id78">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id78">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id79">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id80">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id80">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id81">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id81">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id82">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id82">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id83">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id84">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id85">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id84">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id86">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id87">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id88">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id89">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id90">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id85">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id86">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id87">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id88">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id89">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id91">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id90">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id91">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id92">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id93">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id94">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id95">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
@@ -431,6 +437,10 @@
|
||||
<li><p>Procedurally Generated Maps</p></li>
|
||||
<li><p>Randomize Grass Patterns</p></li>
|
||||
</ul>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>If you are compiling Porymap yourself, these features will only be available if Qt’s <code class="docutils literal notranslate"><span class="pre">qml</span></code> module is installed.</p>
|
||||
</div>
|
||||
<section id="custom-scripts-editor">
|
||||
<h2>Custom Scripts Editor<a class="headerlink" href="#custom-scripts-editor" title="Link to this heading"></a></h2>
|
||||
<p>Your custom scripts can be managed with the Custom Scripts Editor accessible under <code class="docutils literal notranslate"><span class="pre">Options</span> <span class="pre">-></span> <span class="pre">Custom</span> <span class="pre">Scripts...</span></code>.</p>
|
||||
@@ -2247,6 +2257,66 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="js function">
|
||||
<dt class="sig sig-object js" id="map.getMetatileLayerOrder">
|
||||
<span class="sig-prename descclassname"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getMetatileLayerOrder</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getMetatileLayerOrder" title="Link to this definition"></a></dt>
|
||||
<dd><p>Gets the order that metatile layers are rendered for the current layout, where <code class="docutils literal notranslate"><span class="pre">0</span></code> is the bottom layer, <code class="docutils literal notranslate"><span class="pre">1</span></code> is the middle layer, and <code class="docutils literal notranslate"><span class="pre">2</span></code> is the top layer. The default order is <code class="docutils literal notranslate"><span class="pre">[0,</span> <span class="pre">1,</span> <span class="pre">2]</span></code>.</p>
|
||||
<p>If you’d like to get the default metatile layer order for all layouts, see <a class="reference internal" href="#utility.getMetatileLayerOrder" title="utility.getMetatileLayerOrder"><code class="xref js js-func docutils literal notranslate"><span class="pre">utility.getMetatileLayerOrder</span></code></a> instead.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>array of layers</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>array</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="js function">
|
||||
<dt class="sig sig-object js" id="map.setMetatileLayerOrder">
|
||||
<span class="sig-prename descclassname"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">setMetatileLayerOrder</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">order</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#map.setMetatileLayerOrder" title="Link to this definition"></a></dt>
|
||||
<dd><p>Sets the order that metatile layers are rendered for the current layout, where <code class="docutils literal notranslate"><span class="pre">0</span></code> is the bottom layer, <code class="docutils literal notranslate"><span class="pre">1</span></code> is the middle layer, and <code class="docutils literal notranslate"><span class="pre">2</span></code> is the top layer. The default order is <code class="docutils literal notranslate"><span class="pre">[0,</span> <span class="pre">1,</span> <span class="pre">2]</span></code>.</p>
|
||||
<p>If no elements are provided the layer order will be reset to the default. Any layer not listed in the provided <code class="docutils literal notranslate"><span class="pre">order</span></code> will not be rendered. Any additional elements after the first 3 are ignored.</p>
|
||||
<p>If you’d like to set the default metatile layer order for all layouts, see <a class="reference internal" href="#utility.setMetatileLayerOrder" title="utility.setMetatileLayerOrder"><code class="xref js js-func docutils literal notranslate"><span class="pre">utility.setMetatileLayerOrder</span></code></a> instead.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>order</strong> (<span><code class="xref js js-func docutils literal notranslate"><span class="pre">array</span></code></span>) – array of layers</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="js function">
|
||||
<dt class="sig sig-object js" id="map.getMetatileLayerOpacity">
|
||||
<span class="sig-prename descclassname"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getMetatileLayerOpacity</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getMetatileLayerOpacity" title="Link to this definition"></a></dt>
|
||||
<dd><p>Gets the opacities that metatile layers are rendered with for the current layout, where the first element is the bottom layer, the second element is the middle layer, and the third element is the top layer. The default opacities are <code class="docutils literal notranslate"><span class="pre">[1.0,</span> <span class="pre">1.0,</span> <span class="pre">1.0]</span></code>.</p>
|
||||
<p>If you’d like to get the default metatile layer opacities for all layouts, see <a class="reference internal" href="#utility.getMetatileLayerOpacity" title="utility.getMetatileLayerOpacity"><code class="xref js js-func docutils literal notranslate"><span class="pre">utility.getMetatileLayerOpacity</span></code></a> instead.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>array of opacities for each layer</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>array</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="js function">
|
||||
<dt class="sig sig-object js" id="map.setMetatileLayerOpacity">
|
||||
<span class="sig-prename descclassname"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">setMetatileLayerOpacity</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">opacities</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#map.setMetatileLayerOpacity" title="Link to this definition"></a></dt>
|
||||
<dd><p>Sets the opacities that metatile layers are rendered with for the current layout, where the first element is the bottom layer, the second element is the middle layer, and the third element is the top layer. The default opacities are <code class="docutils literal notranslate"><span class="pre">[1.0,</span> <span class="pre">1.0,</span> <span class="pre">1.0]</span></code>.</p>
|
||||
<p>Any additional elements after the first 3 are ignored. Any elements not provided will be rendered with opacity <code class="docutils literal notranslate"><span class="pre">1.0</span></code>.</p>
|
||||
<p>If you’d like to set the default metatile layer opacities for all layouts, see <a class="reference internal" href="#utility.setMetatileLayerOpacity" title="utility.setMetatileLayerOpacity"><code class="xref js js-func docutils literal notranslate"><span class="pre">utility.setMetatileLayerOpacity</span></code></a> instead.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>opacities</strong> (<span><code class="xref js js-func docutils literal notranslate"><span class="pre">array</span></code></span>) – array of opacities for each layer</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="overlay-functions">
|
||||
<h4>Overlay Functions<a class="headerlink" href="#overlay-functions" title="Link to this heading"></a></h4>
|
||||
@@ -3140,10 +3210,11 @@
|
||||
<dl class="js function">
|
||||
<dt class="sig sig-object js" id="utility.getMetatileLayerOrder">
|
||||
<span class="sig-prename descclassname"><span class="n"><span class="pre">utility</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getMetatileLayerOrder</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#utility.getMetatileLayerOrder" title="Link to this definition"></a></dt>
|
||||
<dd><p>Gets the order that metatile layers are rendered.</p>
|
||||
<dd><p>Gets the order that metatile layers are rendered by default, where <code class="docutils literal notranslate"><span class="pre">0</span></code> is the bottom layer, <code class="docutils literal notranslate"><span class="pre">1</span></code> is the middle layer, and <code class="docutils literal notranslate"><span class="pre">2</span></code> is the top layer. The default order is <code class="docutils literal notranslate"><span class="pre">[0,</span> <span class="pre">1,</span> <span class="pre">2]</span></code>.</p>
|
||||
<p>If you’d like to get the metatile layer order for only the current layout, see <a class="reference internal" href="#map.getMetatileLayerOrder" title="map.getMetatileLayerOrder"><code class="xref js js-func docutils literal notranslate"><span class="pre">map.getMetatileLayerOrder</span></code></a> instead.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>array of layers. The bottom layer is represented as 0.</p>
|
||||
<dd class="field-odd"><p>array of layers</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>array</p>
|
||||
@@ -3154,11 +3225,13 @@
|
||||
<dl class="js function">
|
||||
<dt class="sig sig-object js" id="utility.setMetatileLayerOrder">
|
||||
<span class="sig-prename descclassname"><span class="n"><span class="pre">utility</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">setMetatileLayerOrder</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">order</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#utility.setMetatileLayerOrder" title="Link to this definition"></a></dt>
|
||||
<dd><p>Sets the order that metatile layers are rendered.</p>
|
||||
<dd><p>Sets the order that metatile layers are rendered by default, where <code class="docutils literal notranslate"><span class="pre">0</span></code> is the bottom layer, <code class="docutils literal notranslate"><span class="pre">1</span></code> is the middle layer, and <code class="docutils literal notranslate"><span class="pre">2</span></code> is the top layer. The default order is <code class="docutils literal notranslate"><span class="pre">[0,</span> <span class="pre">1,</span> <span class="pre">2]</span></code>.</p>
|
||||
<p>If no elements are provided the layer order will be reset to the default. Any layer not listed in the provided <code class="docutils literal notranslate"><span class="pre">order</span></code> will not be rendered. Any additional elements after the first 3 are ignored.</p>
|
||||
<p>If you’d like to set the metatile layer order for only the current layout, see <a class="reference internal" href="#map.setMetatileLayerOrder" title="map.setMetatileLayerOrder"><code class="xref js js-func docutils literal notranslate"><span class="pre">map.setMetatileLayerOrder</span></code></a> instead.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>order</strong> (<span><code class="xref js js-func docutils literal notranslate"><span class="pre">array</span></code></span>) – array of layers. The bottom layer is represented as 0.</p></li>
|
||||
<li><p><strong>order</strong> (<span><code class="xref js js-func docutils literal notranslate"><span class="pre">array</span></code></span>) – array of layers</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -3167,10 +3240,11 @@
|
||||
<dl class="js function">
|
||||
<dt class="sig sig-object js" id="utility.getMetatileLayerOpacity">
|
||||
<span class="sig-prename descclassname"><span class="n"><span class="pre">utility</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getMetatileLayerOpacity</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#utility.getMetatileLayerOpacity" title="Link to this definition"></a></dt>
|
||||
<dd><p>Gets the opacities that metatile layers are rendered with.</p>
|
||||
<dd><p>Gets the opacities that metatile layers are rendered with by default, where the first element is the bottom layer, the second element is the middle layer, and the third element is the top layer. The default opacities are <code class="docutils literal notranslate"><span class="pre">[1.0,</span> <span class="pre">1.0,</span> <span class="pre">1.0]</span></code>.</p>
|
||||
<p>If you’d like to get the metatile layer opacities for only the current layout, see <a class="reference internal" href="#map.getMetatileLayerOpacity" title="map.getMetatileLayerOpacity"><code class="xref js js-func docutils literal notranslate"><span class="pre">map.getMetatileLayerOpacity</span></code></a> instead.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>array of opacities for each layer. The bottom layer is the first element.</p>
|
||||
<dd class="field-odd"><p>array of opacities for each layer</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>array</p>
|
||||
@@ -3181,11 +3255,13 @@
|
||||
<dl class="js function">
|
||||
<dt class="sig sig-object js" id="utility.setMetatileLayerOpacity">
|
||||
<span class="sig-prename descclassname"><span class="n"><span class="pre">utility</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">setMetatileLayerOpacity</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">opacities</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#utility.setMetatileLayerOpacity" title="Link to this definition"></a></dt>
|
||||
<dd><p>Sets the opacities that metatile layers are rendered with.</p>
|
||||
<dd><p>Sets the opacities that metatile layers are rendered with by default, where the first element is the bottom layer, the second element is the middle layer, and the third element is the top layer. The default opacities are <code class="docutils literal notranslate"><span class="pre">[1.0,</span> <span class="pre">1.0,</span> <span class="pre">1.0]</span></code>.</p>
|
||||
<p>Any additional elements after the first 3 are ignored. Any elements not provided will be rendered with opacity <code class="docutils literal notranslate"><span class="pre">1.0</span></code>.</p>
|
||||
<p>If you’d like to set the metatile layer opacities for only the current layout, see <a class="reference internal" href="#map.setMetatileLayerOpacity" title="map.setMetatileLayerOpacity"><code class="xref js js-func docutils literal notranslate"><span class="pre">map.setMetatileLayerOpacity</span></code></a> instead.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>opacities</strong> (<span><code class="xref js js-func docutils literal notranslate"><span class="pre">array</span></code></span>) – array of opacities for each layer. The bottom layer is the first element.</p></li>
|
||||
<li><p><strong>opacities</strong> (<span><code class="xref js js-func docutils literal notranslate"><span class="pre">array</span></code></span>) – array of opacities for each layer</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
Reference in New Issue
Block a user