<p>Porymap is extensible via scripting capabilities. This allows the user to write custom JavaScript (technically, ECMAScript) files to support enhanced workflows, without having to fork Porymap itself. While the possibilities are endless, some useful examples of scripting might be:</p>
<p>Let’s write a custom script that will randomize grass patterns when the user is editing the map. This is useful, since it’s cumbersome to manually add randomness to grass patches. With the custom script, it will happen automatically. Whenever the user paints a grass tile onto the map, the script will overwrite the tile with a random grass tile instead.</p>
<p>First, create a new script file called <codeclass="docutils literal notranslate"><spanclass="pre">my_script.js</span></code>–place it in the project directory (e.g. <codeclass="docutils literal notranslate"><spanclass="pre">pokefirered/</span></code>).</p>
<p>Next, open the Porymap project config file, <codeclass="docutils literal notranslate"><spanclass="pre">porymap.user.cfg</span></code>, in the project directory. Add the script file to the <codeclass="docutils literal notranslate"><spanclass="pre">custom_scripts</span></code> configuration value. Multiple script files can be loaded by separating the filepaths with a comma.</p>
<p>Now that Porymap is configured to load the script file, let’s write the actual code that will power the grass-randomizer. Scripts have access to several “callbacks” for events that occur while Porymap is running. This means our script can define functions for each of these callbacks. We’re interested in the <codeclass="docutils literal notranslate"><spanclass="pre">onBlockChanged()</span></code> callback, since we want our script to take action whenever a user paints a block on the map.</p>
<divclass="highlight-js notranslate"><divclass="highlight"><pre><span></span><spanclass="c1">// Porymap callback when a block is painted.</span><spanclass="w"></span>
<p>It’s very <strong>important</strong> to remember to <codeclass="docutils literal notranslate"><spanclass="pre">export</span></code> the callback functions in the script. Otherwise, Porymap will not be able to execute them.</p>
<p>In addition to the callbacks, Porymap also supports a scripting API so that the script can interact with Porymap in interesting ways. For example, a script can change a block or add overlay text on the map. Since we want to paint random grass tiles, we’ll be using the <codeclass="docutils literal notranslate"><spanclass="pre">map.setMetatileId()</span></code> function. Let’s fill in the rest of the grass-randomizing code.</p>
<p>Let’s test the script out by re-launching Porymap. If we try to paint grass on the map, we should see our script inserting a nice randomized grass pattern.</p>
<p>The grass-randomizer script above happens implicitly when the user paints on the map. However, other times we probably want to call the custom script on demand. One of the API functions Porymap provides is the ability to trigger scripting functions from the <codeclass="docutils literal notranslate"><spanclass="pre">Tools</span></code> menu, or a keyboard shortcut. To do this, we will usually want to register the action when the project loads. Here is an example script where some custom actions are registered.</p>
<spanclass="w"></span><spanclass="nx">utility</span><spanclass="p">.</span><spanclass="nx">registerAction</span><spanclass="p">(</span><spanclass="s2">"applyNightTint"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s2">"View Night Tint"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s2">"T"</span><spanclass="p">)</span><spanclass="w"></span>
<p>Then, to trigger the <codeclass="docutils literal notranslate"><spanclass="pre">applyNightTint()</span></code> function, we could either click <codeclass="docutils literal notranslate"><spanclass="pre">Tools</span><spanclass="pre">-></span><spanclass="pre">View</span><spanclass="pre">Night</span><spanclass="pre">Tint</span></code> or use the <codeclass="docutils literal notranslate"><spanclass="pre">T</span></code> keyboard shortcut.</p>
<p>Now that we have an overview of how to utilize Porymap’s scripting capabilities, the entire scripting API is documented below.</p>
<h2>Scripting API<aclass="headerlink"href="#scripting-api"title="Permalink to this heading"></a></h2>
<sectionid="callbacks">
<h3>Callbacks<aclass="headerlink"href="#callbacks"title="Permalink to this heading"></a></h3>
<dlclass="js function">
<dtclass="sig sig-object js"id="onProjectOpened">
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onProjectOpened</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">projectPath</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#onProjectOpened"title="Permalink to this definition"></a></dt>
<li><p><strong>projectPath</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the directory path of the opened project</p></li>
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onProjectClosed</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">projectPath</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#onProjectClosed"title="Permalink to this definition"></a></dt>
<li><p><strong>projectPath</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the directory path of the closed project</p></li>
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onMapOpened</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">mapName</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#onMapOpened"title="Permalink to this definition"></a></dt>
<li><p><strong>mapName</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the name of the opened map</p></li>
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onBlockChanged</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prevBlock</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">newBlock</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#onBlockChanged"title="Permalink to this definition"></a></dt>
<dd><p>Called when a block is changed on the map. For example, this is called when a user paints a new tile or changes the collision property of a block.</p>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<li><p><strong>prevBlock</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">object()</span></code></span>) – the block’s state before it was modified. The object’s shape is <codeclass="docutils literal notranslate"><spanclass="pre">{metatileId,</span><spanclass="pre">collision,</span><spanclass="pre">elevation,</span><spanclass="pre">rawValue}</span></code></p></li>
<li><p><strong>newBlock</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">object()</span></code></span>) – the block’s new state after it was modified. The object’s shape is <codeclass="docutils literal notranslate"><spanclass="pre">{metatileId,</span><spanclass="pre">collision,</span><spanclass="pre">elevation,</span><spanclass="pre">rawValue}</span></code></p></li>
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onBorderMetatileChanged</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prevMetatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">newMetatileId</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#onBorderMetatileChanged"title="Permalink to this definition"></a></dt>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<li><p><strong>prevMetatileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the metatile id of the border block before it was modified</p></li>
<li><p><strong>newMetatileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the metatile id of the border block after it was modified</p></li>
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onBlockHoverChanged</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#onBlockHoverChanged"title="Permalink to this definition"></a></dt>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onBlockHoverCleared</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#onBlockHoverCleared"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onMapResized</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">oldWidth</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">oldHeight</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">newWidth</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">newHeight</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#onMapResized"title="Permalink to this definition"></a></dt>
<li><p><strong>oldWidth</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the width of the map before the change</p></li>
<li><p><strong>oldHeight</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the height of the map before the change</p></li>
<li><p><strong>newWidth</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the width of the map after the change</p></li>
<li><p><strong>newHeight</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the height of the map after the change</p></li>
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onBorderResized</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">oldWidth</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">oldHeight</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">newWidth</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">newHeight</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#onBorderResized"title="Permalink to this definition"></a></dt>
<li><p><strong>oldWidth</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the width of the border before the change</p></li>
<li><p><strong>oldHeight</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the height of the border before the change</p></li>
<li><p><strong>newWidth</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the width of the border after the change</p></li>
<li><p><strong>newHeight</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the height of the border after the change</p></li>
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onMapShifted</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">xDelta</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">yDelta</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#onMapShifted"title="Permalink to this definition"></a></dt>
<li><p><strong>xDelta</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the horizontal change from the shift</p></li>
<li><p><strong>yDelta</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the vertical change from the shift</p></li>
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onTilesetUpdated</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">tilesetName</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#onTilesetUpdated"title="Permalink to this definition"></a></dt>
<li><p><strong>tilesetName</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the name of the updated tileset</p></li>
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onMainTabChanged</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">oldTab</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">newTab</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#onMainTabChanged"title="Permalink to this definition"></a></dt>
<dd><p>Called when the selected tab in the main tab bar is changed. Tabs are indexed from left to right, starting at 0 (<codeclass="docutils literal notranslate"><spanclass="pre">0</span></code>: Map, <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code>: Events, <codeclass="docutils literal notranslate"><spanclass="pre">2</span></code>: Header, <codeclass="docutils literal notranslate"><spanclass="pre">3</span></code>: Connections, <codeclass="docutils literal notranslate"><spanclass="pre">4</span></code>: Wild Pokemon).</p>
<li><p><strong>oldTab</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the index of the previously selected tab</p></li>
<li><p><strong>newTab</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the index of the newly selected tab</p></li>
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onMapViewTabChanged</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">oldTab</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">newTab</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#onMapViewTabChanged"title="Permalink to this definition"></a></dt>
<dd><p>Called when the selected tab in the map view tab bar is changed. Tabs are indexed from left to right, starting at 0 (<codeclass="docutils literal notranslate"><spanclass="pre">0</span></code>: Metatiles, <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code>: Collision, <codeclass="docutils literal notranslate"><spanclass="pre">2</span></code>: Prefabs).</p>
<li><p><strong>oldTab</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the index of the previously selected tab</p></li>
<li><p><strong>newTab</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the index of the newly selected tab</p></li>
<spanclass="sig-name descname"><spanclass="n"><spanclass="pre">onBorderVisibilityToggled</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">visible</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#onBorderVisibilityToggled"title="Permalink to this definition"></a></dt>
<li><p><strong>visible</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the border is now visible</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getBlock</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getBlock"title="Permalink to this definition"></a></dt>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<li><p><strong>metatileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the metatile id of the block</p></li>
<li><p><strong>collision</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the collision of the block (<codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> = passable, <codeclass="docutils literal notranslate"><spanclass="pre">1-3</span></code> = impassable)</p></li>
<li><p><strong>elevation</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the elevation of the block</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<li><p><strong>commitChanges</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Commit the changes to the map’s edit/undo history. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. When making many related map edits, it can be useful to set this to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, and then commit all of them together with <codeclass="docutils literal notranslate"><spanclass="pre">map.commit()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setBlock</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">rawValue</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">commitChanges</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id0"title="Permalink to this definition"></a></dt>
<dd><p>Sets a block in the currently-opened map. This is an overloaded function that takes the raw value of a block instead of each of the block’s properties individually.</p>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<li><p><strong>rawValue</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the 16 bit value of the block. Bits <codeclass="docutils literal notranslate"><spanclass="pre">0-9</span></code> will be the metatile id, bits <codeclass="docutils literal notranslate"><spanclass="pre">10-11</span></code> will be the collision, and bits <codeclass="docutils literal notranslate"><spanclass="pre">12-15</span></code> will be the elevation.</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<li><p><strong>commitChanges</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Commit the changes to the map’s edit/undo history. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. When making many related map edits, it can be useful to set this to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, and then commit all of them together with <codeclass="docutils literal notranslate"><spanclass="pre">map.commit()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMetatileId</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getMetatileId"title="Permalink to this definition"></a></dt>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setMetatileId</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">commitChanges</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setMetatileId"title="Permalink to this definition"></a></dt>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<li><p><strong>metatileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the metatile id of the block</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<li><p><strong>commitChanges</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Commit the changes to the map’s edit/undo history. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. When making many related map edits, it can be useful to set this to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, and then commit all of them together with <codeclass="docutils literal notranslate"><spanclass="pre">map.commit()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getBorderMetatileId</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getBorderMetatileId"title="Permalink to this definition"></a></dt>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setBorderMetatileId</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">commitChanges</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setBorderMetatileId"title="Permalink to this definition"></a></dt>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<li><p><strong>metatileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the metatile id of the block</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<li><p><strong>commitChanges</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Commit the changes to the map’s edit/undo history. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. When making many related map edits, it can be useful to set this to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, and then commit all of them together with <codeclass="docutils literal notranslate"><spanclass="pre">map.commit()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getCollision</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getCollision"title="Permalink to this definition"></a></dt>
<dd><p>Gets the collision of a block in the currently-opened map. (<codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> = passable, <codeclass="docutils literal notranslate"><spanclass="pre">1-3</span></code> = impassable)</p>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setCollision</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">collision</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">commitChanges</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setCollision"title="Permalink to this definition"></a></dt>
<dd><p>Sets the collision of a block in the currently-opened map. (<codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> = passable, <codeclass="docutils literal notranslate"><spanclass="pre">1-3</span></code> = impassable)</p>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<li><p><strong>collision</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the collision of the block</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<li><p><strong>commitChanges</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Commit the changes to the map’s edit/undo history. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. When making many related map edits, it can be useful to set this to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, and then commit all of them together with <codeclass="docutils literal notranslate"><spanclass="pre">map.commit()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getElevation</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getElevation"title="Permalink to this definition"></a></dt>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setElevation</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">elevation</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">commitChanges</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setElevation"title="Permalink to this definition"></a></dt>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – x coordinate of the block</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – y coordinate of the block</p></li>
<li><p><strong>elevation</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the elevation of the block</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<li><p><strong>commitChanges</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Commit the changes to the map’s edit/undo history. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. When making many related map edits, it can be useful to set this to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, and then commit all of them together with <codeclass="docutils literal notranslate"><spanclass="pre">map.commit()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setBlocksFromSelection</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">commitChanges</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setBlocksFromSelection"title="Permalink to this definition"></a></dt>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<li><p><strong>commitChanges</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Commit the changes to the map’s edit/undo history. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. When making many related map edits, it can be useful to set this to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, and then commit all of them together with <codeclass="docutils literal notranslate"><spanclass="pre">map.commit()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">bucketFill</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">commitChanges</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.bucketFill"title="Permalink to this definition"></a></dt>
<li><p><strong>metatileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – metatile id to fill</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<li><p><strong>commitChanges</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Commit the changes to the map’s edit/undo history. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. When making many related map edits, it can be useful to set this to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, and then commit all of them together with <codeclass="docutils literal notranslate"><spanclass="pre">map.commit()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">bucketFillFromSelection</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">commitChanges</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.bucketFillFromSelection"title="Permalink to this definition"></a></dt>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<li><p><strong>commitChanges</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Commit the changes to the map’s edit/undo history. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. When making many related map edits, it can be useful to set this to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, and then commit all of them together with <codeclass="docutils literal notranslate"><spanclass="pre">map.commit()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">magicFill</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">commitChanges</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.magicFill"title="Permalink to this definition"></a></dt>
<li><p><strong>metatileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – metatile id to magic fill</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<li><p><strong>commitChanges</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Commit the changes to the map’s edit/undo history. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. When making many related map edits, it can be useful to set this to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, and then commit all of them together with <codeclass="docutils literal notranslate"><spanclass="pre">map.commit()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">magicFillFromSelection</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">commitChanges</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.magicFillFromSelection"title="Permalink to this definition"></a></dt>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<li><p><strong>commitChanges</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Commit the changes to the map’s edit/undo history. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. When making many related map edits, it can be useful to set this to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, and then commit all of them together with <codeclass="docutils literal notranslate"><spanclass="pre">map.commit()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">shift</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">xDelta</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">yDelta</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">commitChanges</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.shift"title="Permalink to this definition"></a></dt>
<li><p><strong>xDelta</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – number of blocks to shift horizontally</p></li>
<li><p><strong>yDelta</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – number of blocks to shift vertically</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<li><p><strong>commitChanges</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Commit the changes to the map’s edit/undo history. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. When making many related map edits, it can be useful to set this to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, and then commit all of them together with <codeclass="docutils literal notranslate"><spanclass="pre">map.commit()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getDimensions</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getDimensions"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getWidth</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getWidth"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getHeight</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getHeight"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getBorderDimensions</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getBorderDimensions"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getBorderWidth</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getBorderWidth"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getBorderHeight</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getBorderHeight"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setDimensions</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">width</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">height</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setDimensions"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setWidth</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">width</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setWidth"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setHeight</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setHeight"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setBorderDimensions</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">width</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">height</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setBorderDimensions"title="Permalink to this definition"></a></dt>
<dd><p>Sets the dimensions of the border of the currently-opened map. If the config setting <codeclass="docutils literal notranslate"><spanclass="pre">use_custom_border_size</span></code> is set to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> then this does nothing.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setBorderWidth</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">width</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setBorderWidth"title="Permalink to this definition"></a></dt>
<dd><p>Sets the width of the border of the currently-opened map. If the config setting <codeclass="docutils literal notranslate"><spanclass="pre">use_custom_border_size</span></code> is set to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> then this does nothing.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setBorderHeight</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">height</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setBorderHeight"title="Permalink to this definition"></a></dt>
<dd><p>Sets the height of the border of the currently-opened map. If the config setting <codeclass="docutils literal notranslate"><spanclass="pre">use_custom_border_size</span></code> is set to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> then this does nothing.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">redraw</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.redraw"title="Permalink to this definition"></a></dt>
<dd><p>Redraws the entire map area. Useful when delaying map redraws using <codeclass="docutils literal notranslate"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">false</span></code> in certain map editing functions.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">commit</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.commit"title="Permalink to this definition"></a></dt>
<dd><p>Commits any uncommitted changes to the map’s edit/undo history. Useful when delaying commits using <codeclass="docutils literal notranslate"><spanclass="pre">commitChanges</span><spanclass="pre">=</span><spanclass="pre">false</span></code> in certain map editing functions.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getSong</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getSong"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setSong</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">song</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setSong"title="Permalink to this definition"></a></dt>
<dd><p>Sets the name of the background song for the currently-opened map. The song name must be one of the names in the “Song” dropdown menu on the Header tab.</p>
<li><p><strong>song</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the name of the song</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getLocation</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getLocation"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setLocation</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">location</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setLocation"title="Permalink to this definition"></a></dt>
<dd><p>Sets the name of the region map location for the currently-opened map. The location name must be one of the names in the “Location” dropdown menu on the Header tab.</p>
<li><p><strong>location</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the name of the location</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getRequiresFlash</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getRequiresFlash"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setRequiresFlash</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">require</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setRequiresFlash"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getWeather</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getWeather"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setWeather</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">weather</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setWeather"title="Permalink to this definition"></a></dt>
<dd><p>Sets the name of the weather for the currently-opened map. The weather name must be one of the names in the “Weather” dropdown menu on the Header tab.</p>
<li><p><strong>weather</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the name of the weather</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getType</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getType"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setType</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setType"title="Permalink to this definition"></a></dt>
<dd><p>Sets the name of the map type for the currently-opened map. The map type name must be one of the names in the “Type” dropdown menu on the Header tab.</p>
<li><p><strong>type</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the name of the map type</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getBattleScene</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getBattleScene"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setBattleScene</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">battleScene</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setBattleScene"title="Permalink to this definition"></a></dt>
<dd><p>Sets the name of the battle scene for the currently-opened map. The battle scene name must be one of the names in the “Battle scene” dropdown menu on the Header tab.</p>
<li><p><strong>battleScene</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the name of the battle scene</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getShowLocationName</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getShowLocationName"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setShowLocationName</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">show</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setShowLocationName"title="Permalink to this definition"></a></dt>
<li><p><strong>show</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the location name should be shown</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getAllowRunning</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getAllowRunning"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setAllowRunning</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">allow</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setAllowRunning"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getAllowBiking</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getAllowBiking"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setAllowBiking</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">allow</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setAllowBiking"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getAllowEscaping</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getAllowEscaping"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setAllowEscaping</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">allow</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setAllowEscaping"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getFloorNumber</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getFloorNumber"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setFloorNumber</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">floorNumber</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setFloorNumber"title="Permalink to this definition"></a></dt>
<p>The following functions are related to tilesets and how they are rendered. The functions with “preview” in their name operate on a “fake” version of the palette colors. This means that changing these “preview” colors won’t affect the actual tileset colors in the project. A good use of the “preview” palettes would be Day/Night tints, for example.</p>
<p>All tileset functions are callable via the global <codeclass="docutils literal notranslate"><spanclass="pre">map</span></code> object.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getPrimaryTileset</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getPrimaryTileset"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setPrimaryTileset</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">tileset</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setPrimaryTileset"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getSecondaryTileset</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getSecondaryTileset"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setSecondaryTileset</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">tileset</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setSecondaryTileset"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getNumPrimaryTilesetTiles</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getNumPrimaryTilesetTiles"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getNumSecondaryTilesetTiles</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getNumSecondaryTilesetTiles"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getNumPrimaryTilesetMetatiles</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getNumPrimaryTilesetMetatiles"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getNumSecondaryTilesetMetatiles</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getNumSecondaryTilesetMetatiles"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getPrimaryTilesetPalettePreview</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">paletteIndex</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getPrimaryTilesetPalettePreview"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setPrimaryTilesetPalettePreview</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">paletteIndex</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">colors</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setPrimaryTilesetPalettePreview"title="Permalink to this definition"></a></dt>
<dd><p>Sets a palette in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.</p>
<li><p><strong>colors</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of colors. Each color is a 3-element RGB array</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Redraw the elements with the updated palette. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set <codeclass="docutils literal notranslate"><spanclass="pre">redraw</span></code> to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> on the final call.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getPrimaryTilesetPalettesPreview</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getPrimaryTilesetPalettesPreview"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setPrimaryTilesetPalettesPreview</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">palettes</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setPrimaryTilesetPalettesPreview"title="Permalink to this definition"></a></dt>
<dd><p>Sets all of the palettes in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.</p>
<li><p><strong>palettes</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of arrays of colors. Each color is a 3-element RGB array</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Redraw the elements with the updated palettes. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set <codeclass="docutils literal notranslate"><spanclass="pre">redraw</span></code> to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> on the final call.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getSecondaryTilesetPalettePreview</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">paletteIndex</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getSecondaryTilesetPalettePreview"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setSecondaryTilesetPalettePreview</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">paletteIndex</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">colors</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setSecondaryTilesetPalettePreview"title="Permalink to this definition"></a></dt>
<dd><p>Sets a palette in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.</p>
<li><p><strong>colors</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of colors. Each color is a 3-element RGB array</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Redraw the elements with the updated palette. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set <codeclass="docutils literal notranslate"><spanclass="pre">redraw</span></code> to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> on the final call.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getSecondaryTilesetPalettesPreview</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getSecondaryTilesetPalettesPreview"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setSecondaryTilesetPalettesPreview</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">palettes</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setSecondaryTilesetPalettesPreview"title="Permalink to this definition"></a></dt>
<dd><p>Sets all of the palettes in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.</p>
<li><p><strong>palettes</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of arrays of colors. Each color is a 3-element RGB array</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Redraw the elements with the updated palettes. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set <codeclass="docutils literal notranslate"><spanclass="pre">redraw</span></code> to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> on the final call.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getPrimaryTilesetPalette</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">paletteIndex</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getPrimaryTilesetPalette"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setPrimaryTilesetPalette</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">paletteIndex</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">colors</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setPrimaryTilesetPalette"title="Permalink to this definition"></a></dt>
<li><p><strong>colors</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of colors. Each color is a 3-element RGB array</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Redraw the elements with the updated palette. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set <codeclass="docutils literal notranslate"><spanclass="pre">redraw</span></code> to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> on the final call.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getPrimaryTilesetPalettes</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getPrimaryTilesetPalettes"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setPrimaryTilesetPalettes</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">palettes</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setPrimaryTilesetPalettes"title="Permalink to this definition"></a></dt>
<dd><p>Sets all of the palettes in the primary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.</p>
<li><p><strong>palettes</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of arrays of colors. Each color is a 3-element RGB array</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Redraw the elements with the updated palettes. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set <codeclass="docutils literal notranslate"><spanclass="pre">redraw</span></code> to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> on the final call.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getSecondaryTilesetPalette</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">paletteIndex</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getSecondaryTilesetPalette"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setSecondaryTilesetPalette</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">paletteIndex</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">colors</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setSecondaryTilesetPalette"title="Permalink to this definition"></a></dt>
<li><p><strong>colors</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of colors. Each color is a 3-element RGB array</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Redraw the elements with the updated palette. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set <codeclass="docutils literal notranslate"><spanclass="pre">redraw</span></code> to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> on the final call.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getSecondaryTilesetPalettes</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getSecondaryTilesetPalettes"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setSecondaryTilesetPalettes</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">palettes</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setSecondaryTilesetPalettes"title="Permalink to this definition"></a></dt>
<dd><p>Sets all of the palettes in the secondary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.</p>
<li><p><strong>palettes</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of arrays of colors. Each color is a 3-element RGB array</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Redraw the elements with the updated palettes. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set <codeclass="docutils literal notranslate"><spanclass="pre">redraw</span></code> to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> on the final call.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMetatileLabel</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getMetatileLabel"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setMetatileLabel</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">label</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setMetatileLabel"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMetatileLayerType</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getMetatileLayerType"title="Permalink to this definition"></a></dt>
<dd><p>Gets the layer type for the specified metatile. <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code>: Middle/Top, <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code>: Bottom/Middle, <codeclass="docutils literal notranslate"><spanclass="pre">2</span></code>: Bottom/Top.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setMetatileLayerType</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layerType</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setMetatileLayerType"title="Permalink to this definition"></a></dt>
<dd><p>Sets the layer type for the specified metatile. <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code>: Middle/Top, <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code>: Bottom/Middle, <codeclass="docutils literal notranslate"><spanclass="pre">2</span></code>: Bottom/Top.</p>
<p><strong>Warning:</strong> This function writes directly to the tileset. There is no undo for this.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMetatileEncounterType</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getMetatileEncounterType"title="Permalink to this definition"></a></dt>
<dd><p>Gets the encounter type for the specified metatile. <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code>: None, <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code>: Land, <codeclass="docutils literal notranslate"><spanclass="pre">2</span></code>: Water</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setMetatileEncounterType</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">encounterType</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setMetatileEncounterType"title="Permalink to this definition"></a></dt>
<dd><p>Sets the encounter type for the specified metatile. <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code>: None, <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code>: Land, <codeclass="docutils literal notranslate"><spanclass="pre">2</span></code>: Water</p>
<p><strong>Warning:</strong> This function writes directly to the tileset. There is no undo for this.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMetatileTerrainType</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getMetatileTerrainType"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setMetatileTerrainType</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">terrainType</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setMetatileTerrainType"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMetatileBehavior</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getMetatileBehavior"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setMetatileBehavior</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">behavior</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setMetatileBehavior"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMetatileAttributes</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getMetatileAttributes"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setMetatileAttributes</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">attributes</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.setMetatileAttributes"title="Permalink to this definition"></a></dt>
<dd><p>Sets the raw attributes value for the specified metatile.</p>
<p><strong>Warning:</strong> This function writes directly to the tileset. There is no undo for this. Porymap will not limit the value of existing attributes to their usual range.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMetatileTile</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tileIndex</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getMetatileTile"title="Permalink to this definition"></a></dt>
<li><p><strong>metatileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – id of target metatile</p></li>
<li><p><strong>tileIndex</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – index of the tile to get</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMetatileTiles</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tileStart</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tileEnd</span><spanclass="pre">=</span><spanclass="pre">-1</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getMetatileTiles"title="Permalink to this definition"></a></dt>
<li><p><strong>metatileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – id of target metatile</p></li>
<li><p><strong>tileStart</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – index of the first tile to get. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> (the first tile)</p></li>
<li><p><strong>tileEnd</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – index of the last tile to get. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">-1</span></code> (the last tile)</p></li>
<ddclass="field-even"><p>array of tiles in the specified range. Each tile is an object of the form <codeclass="docutils literal notranslate"><spanclass="pre">{tileId,</span><spanclass="pre">xflip,</span><spanclass="pre">yflip,</span><spanclass="pre">palette}</span></code></p>
<li><p><strong>metatileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – id of target metatile</p></li>
<li><p><strong>tileIndex</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – index of the tile to set</p></li>
<li><p><strong>xflip</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the new tile is flipped horizontally</p></li>
<li><p><strong>yflip</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the new tile is flipped vertically</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setMetatileTile</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tileIndex</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tile</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id1"title="Permalink to this definition"></a></dt>
<dd><p>Sets the tile at the specified index of the metatile. This is an overloaded function that takes a single tile as a JavaScript object instead of each of the tile’s properties individually.</p>
<p><strong>Warning:</strong> This function writes directly to the tileset. There is no undo for this.</p>
<li><p><strong>metatileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – id of target metatile</p></li>
<li><p><strong>tileIndex</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – index of the tile to set</p></li>
<li><p><strong>tile</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">{tileId,xflip,yflip,palette}()</span></code></span>) – the new tile</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<li><p><strong>xflip</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the new tiles are flipped horizontally</p></li>
<li><p><strong>yflip</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the new tiles are flipped vertically</p></li>
<li><p><strong>tileStart</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – index of the first tile to set. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> (the first tile)</p></li>
<li><p><strong>tileEnd</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – index of the last tile to set. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">-1</span></code> (the last tile)</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setMetatileTiles</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tiles</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tileStart</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tileEnd</span><spanclass="pre">=</span><spanclass="pre">-1</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">forceRedraw</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id2"title="Permalink to this definition"></a></dt>
<dd><p>Sets the tiles in the specified range of the metatile. This is an overloaded function that takes an array of tiles as JavaScript objects instead of each of the tile properties individually.</p>
<p><strong>Warning:</strong> This function writes directly to the tileset. There is no undo for this.</p>
<li><p><strong>metatileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – id of target metatile</p></li>
<li><p><strong>tiles</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of tiles to set. Each tile is an object of the form <codeclass="docutils literal notranslate"><spanclass="pre">{tileId,</span><spanclass="pre">xflip,</span><spanclass="pre">yflip,</span><spanclass="pre">palette}</span></code>. If the array does not have sufficient objects to set all the tiles in the specified range then the remaining tiles will be set with all default values.</p></li>
<li><p><strong>tileStart</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – index of the first tile to set. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> (the first tile)</p></li>
<li><p><strong>tileEnd</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – index of the last tile to set. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">-1</span></code> (the last tile)</p></li>
<li><p><strong>forceRedraw</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – Force the map view to refresh. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Redrawing the map view is expensive, so set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when making many consecutive map edits, and then redraw the map once using <codeclass="docutils literal notranslate"><spanclass="pre">map.redraw()</span></code>.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">map</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getTilePixels</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">tileId</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#map.getTilePixels"title="Permalink to this definition"></a></dt>
<dd><p>Gets the pixel data for the specified tile. The pixel data is an array of indexes indicating which palette color each pixel uses. Tiles are 8x8, so the pixel array will be 64 elements long.</p>
<p>The following functions are related to an overlay that is drawn on top of the map area. Text, images, and shapes can be drawn using these functions. Items can be drawn and manipulated on separate layers by specifiying a layer id. Items on higher layer ids will be drawn above those on lower layers. The visibility, opacity, position, rotation, and scale of each layer can be changed; by default all layers are visible, have an opacity of <codeclass="docutils literal notranslate"><spanclass="pre">100</span></code>, are at position <codeclass="docutils literal notranslate"><spanclass="pre">0,0</span></code>, an angle of <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code>, and a horizontal and vertical scale of <codeclass="docutils literal notranslate"><spanclass="pre">1.0</span></code>.</p>
<p>All overlay functions are callable via the global <codeclass="docutils literal notranslate"><spanclass="pre">overlay</span></code> object.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">clear</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.clear"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">clear</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#id3"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">hide</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.hide"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">hide</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#id4"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">show</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.show"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">show</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#id5"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getVisibility</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.getVisibility"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setVisibility</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">visible</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.setVisibility"title="Permalink to this definition"></a></dt>
<li><p><strong>visible</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the layer should be showing</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setVisibility</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">visible</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id6"title="Permalink to this definition"></a></dt>
<li><p><strong>visible</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the layers should be showing</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getOpacity</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.getOpacity"title="Permalink to this definition"></a></dt>
<dd><p>Gets the opacity of the specified overlay layer. Opacity ranges from <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> (invisible) to <codeclass="docutils literal notranslate"><spanclass="pre">100</span></code> (completely opaque).</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setOpacity</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">opacity</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.setOpacity"title="Permalink to this definition"></a></dt>
<dd><p>Sets the opacity of the specified overlay layer. Opacity ranges from <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> (invisible) to <codeclass="docutils literal notranslate"><spanclass="pre">100</span></code> (completely opaque).</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setOpacity</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">opacity</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id7"title="Permalink to this definition"></a></dt>
<dd><p>This is an overloaded function. Sets the opacity of all active overlay layers. Layers that have not been used yet will not have their opacity changed. Opacity ranges from <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> (invisible) to <codeclass="docutils literal notranslate"><spanclass="pre">100</span></code> (completely opaque).</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getHorizontalScale</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.getHorizontalScale"title="Permalink to this definition"></a></dt>
<dd><p>Gets the horizontal scale of the specified overlay layer. <codeclass="docutils literal notranslate"><spanclass="pre">1.0</span></code> is normal size.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getVerticalScale</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.getVerticalScale"title="Permalink to this definition"></a></dt>
<dd><p>Gets the vertical scale of the specified overlay layer. <codeclass="docutils literal notranslate"><spanclass="pre">1.0</span></code> is normal size.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setHorizontalScale</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">scale</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.setHorizontalScale"title="Permalink to this definition"></a></dt>
<dd><p>Sets the horizontal scale of the specified overlay layer. <codeclass="docutils literal notranslate"><spanclass="pre">1.0</span></code> is normal size.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setHorizontalScale</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">scale</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id8"title="Permalink to this definition"></a></dt>
<dd><p>This is an overloaded function. Sets the horizontal scale of all active overlay layers. Layers that have not been used yet will not have their scale changed. <codeclass="docutils literal notranslate"><spanclass="pre">1.0</span></code> is normal size.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setVerticalScale</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">scale</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.setVerticalScale"title="Permalink to this definition"></a></dt>
<dd><p>Sets the vertical scale of the specified overlay layer. <codeclass="docutils literal notranslate"><spanclass="pre">1.0</span></code> is normal size.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setVerticalScale</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">scale</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id9"title="Permalink to this definition"></a></dt>
<dd><p>This is an overloaded function. Sets the vertical scale of all active overlay layers. Layers that have not been used yet will not have their scale changed. <codeclass="docutils literal notranslate"><spanclass="pre">1.0</span></code> is normal size.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getRotation</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.getRotation"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setRotation</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">angle</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.setRotation"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setRotation</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">angle</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id10"title="Permalink to this definition"></a></dt>
<dd><p>This is an overloaded function. Sets the angle that all active overlay layers are rotated to. Layers that have not been used yet will not have their angle changed.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">rotate</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">degrees</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.rotate"title="Permalink to this definition"></a></dt>
<dd><p>Rotates the specified overlay layer. A positive number of degrees is clockwise rotation, a negative number of degrees is counterclockwise rotation.</p>
<li><p><strong>degrees</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the number of degrees to rotate</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">rotate</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">degrees</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id11"title="Permalink to this definition"></a></dt>
<dd><p>This is an overloaded function. Rotates the all active overlay layers. Layers that have not been used yet will not be rotated. A positive number of degrees is clockwise rotation, a negative number of degrees is counterclockwise rotation.</p>
<li><p><strong>degrees</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the number of degrees to rotate</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getX</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.getX"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getY</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.getY"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setX</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.setX"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setX</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id12"title="Permalink to this definition"></a></dt>
<dd><p>This is an overloaded function. Sets the x position of all active overlay layers. Layers that have not been used yet will not have their position changed.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setY</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.setY"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setY</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id13"title="Permalink to this definition"></a></dt>
<dd><p>This is an overloaded function. Sets the y position of all active overlay layers. Layers that have not been used yet will not have their position changed.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setClippingRect</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">width</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">height</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.setClippingRect"title="Permalink to this definition"></a></dt>
<dd><p>Sets the rectangular clipping region for the specifieid overlay layer. A clipping region will cause the overlay’s rendering to be contained inside it. In other words, any content from the overlay layer will not be visible outside of the specified rectangle.</p>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the rectangle’s pixel x coordinate, 0 is the left edge of the current map. A negative value is where the left map border’s region is</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the rectangle’s pixel y coordinate, 0 is the top edge of the current map. A negative value is where the top map border’s region is</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setClippingRect</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">width</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">height</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id14"title="Permalink to this definition"></a></dt>
<dd><p>This is an overloaded function. Sets the rectangular clipping region for all overlay layers. A clipping region will cause the overlay’s rendering to be contained inside it. In other words, any content from the overlay layer will not be visible outside of the specified rectangle.</p>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the rectangle’s pixel x coordinate, 0 is the left edge of the current map. A negative value is where the left map border’s region is</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the rectangle’s pixel y coordinate, 0 is the top edge of the current map. A negative value is where the top map border’s region is</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">clearClippingRect</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.clearClippingRect"title="Permalink to this definition"></a></dt>
<dd><p>Clears any clipping for the specified overlay layer. See <codeclass="docutils literal notranslate"><spanclass="pre">setClippingRect</span></code> for more info about clipping.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">clearClippingRect</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#id15"title="Permalink to this definition"></a></dt>
<dd><p>Clears any clipping for all overlay layers. See <codeclass="docutils literal notranslate"><spanclass="pre">setClippingRect</span></code> for more info about clipping.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getPosition</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.getPosition"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setPosition</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.setPosition"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setPosition</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id16"title="Permalink to this definition"></a></dt>
<dd><p>This is an overloaded function. Sets the position of all active overlay layers. Layers that have not been used yet will not have their position changed.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">move</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">deltaX</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">deltaY</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.move"title="Permalink to this definition"></a></dt>
<li><p><strong>deltaX</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the number of pixels to move horizontally</p></li>
<li><p><strong>deltaY</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the number of pixels to move vertically</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">move</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">deltaX</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">deltaY</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id17"title="Permalink to this definition"></a></dt>
<li><p><strong>deltaX</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the number of pixels to move horizontally</p></li>
<li><p><strong>deltaY</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the number of pixels to move vertically</p></li>
<dd><p>Adds a text item to the specified overlay layer. Text can be additionally formatted with a <aclass="reference external"href="https://doc.qt.io/qt-5/richtext-html-subset.html#supported-tags">limited set of HTML tags</a>. Note that only text can be displayed, so text decoration like underlines or table borders will not appear.</p>
<li><p><strong>text</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the text to display</p></li>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the x pixel coordinate of the text (relative to the layer’s position)</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the y pixel coordinate of the text (relative to the layer’s position)</p></li>
<li><p><strong>color</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the color of the text. Can be specified as <codeclass="docutils literal notranslate"><spanclass="pre">"#RRGGBB"</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">"#AARRGGBB"</span></code>. Defaults to black.</p></li>
<li><p><strong>size</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the font size of the text. Defaults to 12.</p></li>
<li><p><strong>layer</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the layer id. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the x pixel coordinate of the rectangle’s top-left corner (relative to the layer’s position)</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the y pixel coordinate of the rectangle’s top-left corner (relative to the layer’s position)</p></li>
<li><p><strong>width</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the pixel width of the rectangle</p></li>
<li><p><strong>height</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the pixel height of the rectangle</p></li>
<li><p><strong>borderColor</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the color of the rectangle’s border. Can be specified as <codeclass="docutils literal notranslate"><spanclass="pre">"#RRGGBB"</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">"#AARRGGBB"</span></code>. Defaults to black.</p></li>
<li><p><strong>fillColor</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the color of the area enclosed by the rectangle. Can be specified as <codeclass="docutils literal notranslate"><spanclass="pre">"#RRGGBB"</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">"#AARRGGBB"</span></code>. Defaults to transparent.</p></li>
<li><p><strong>rounding</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the percent degree the corners will be rounded. <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> is rectangular, <codeclass="docutils literal notranslate"><spanclass="pre">100</span></code> is elliptical. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<li><p><strong>layer</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the layer id. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">addPath</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">coords</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">borderColor</span><spanclass="pre">=</span><spanclass="pre">"#000000"</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">fillColor</span><spanclass="pre">=</span><spanclass="pre">""</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.addPath"title="Permalink to this definition"></a></dt>
<dd><p>Draws a straight path on the specified layer by connecting the coordinate pairs in <codeclass="docutils literal notranslate"><spanclass="pre">coords</span></code>. The area enclosed by the path can be colored in, and will follow the <aclass="reference external"href="https://doc.qt.io/qt-5/qt.html#FillRule-enum">“odd-even” fill rule</a>.</p>
<li><p><strong>coords</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of pixel coordinates to connect to create the path. Each element of the array should be an array containing an x and y pixel coordinate</p></li>
<li><p><strong>borderColor</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the color of the path. Can be specified as <codeclass="docutils literal notranslate"><spanclass="pre">"#RRGGBB"</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">"#AARRGGBB"</span></code>. Defaults to black.</p></li>
<li><p><strong>fillColor</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the color of the area enclosed by the path. Can be specified as <codeclass="docutils literal notranslate"><spanclass="pre">"#RRGGBB"</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">"#AARRGGBB"</span></code>. Defaults to transparent.</p></li>
<li><p><strong>layer</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the layer id. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">addPath</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">xCoords</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">yCoords</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">borderColor</span><spanclass="pre">=</span><spanclass="pre">"#000000"</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">fillColor</span><spanclass="pre">=</span><spanclass="pre">""</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id18"title="Permalink to this definition"></a></dt>
<dd><p>This is an overloaded function. Draws a straight path on the specified layer by connecting the coordinates at (<codeclass="docutils literal notranslate"><spanclass="pre">xCoords</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">yCoords</span></code>). The area enclosed by the path can be colored in, and will follow the <aclass="reference external"href="https://doc.qt.io/qt-5/qt.html#FillRule-enum">“odd-even” fill rule</a>.</p>
<li><p><strong>xCoords</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of x pixel coordinates to connect to create the path</p></li>
<li><p><strong>yCoords</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of y pixel coordinates to connect to create the path</p></li>
<li><p><strong>borderColor</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the color of the path. Can be specified as <codeclass="docutils literal notranslate"><spanclass="pre">"#RRGGBB"</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">"#AARRGGBB"</span></code>. Defaults to black.</p></li>
<li><p><strong>fillColor</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the color of the area enclosed by the path. Can be specified as <codeclass="docutils literal notranslate"><spanclass="pre">"#RRGGBB"</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">"#AARRGGBB"</span></code>. Defaults to transparent.</p></li>
<li><p><strong>layer</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the layer id. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">addImage</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">filepath</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">useCache</span><spanclass="pre">=</span><spanclass="pre">true</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.addImage"title="Permalink to this definition"></a></dt>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)</p></li>
<li><p><strong>layer</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the layer id. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<li><p><strong>useCache</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the image should be saved/loaded using the cache. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Reading images from a file is slow. Setting <codeclass="docutils literal notranslate"><spanclass="pre">useCache</span></code> to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> will save the image to memory so that the next time the filepath is encountered the image can be loaded from memory rather than the file.</p></li>
<dd><p>Creates an image item on the specified overlay layer. This differs from <codeclass="docutils literal notranslate"><spanclass="pre">overlay.addImage</span></code> by allowing the new image to be a transformation of the image file.</p>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)</p></li>
<li><p><strong>width</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the width in pixels of the area to read in the image. If <codeclass="docutils literal notranslate"><spanclass="pre">-1</span></code>, use the full width of the original image. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">-1</span></code></p></li>
<li><p><strong>height</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the height in pixels of the area to read in the image. If <codeclass="docutils literal notranslate"><spanclass="pre">-1</span></code>, use the full height of the original image. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">-1</span></code></p></li>
<li><p><strong>xOffset</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the x pixel coordinate on the original image where data should be read from. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<li><p><strong>yOffset</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the y pixel coordinate on the original image where data should be read from. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<li><p><strong>hScale</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the horizontal scale for the image. Negative values will be a horizontal flip of the original image. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code></p></li>
<li><p><strong>vScale</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the vertical scale for the image. Negative values will be a vertical flip of the original image. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code></p></li>
<li><p><strong>paletteId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the id of which currently loaded tileset palette to use for the image. If <codeclass="docutils literal notranslate"><spanclass="pre">-1</span></code>, use the original image’s palette. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">-1</span></code></p></li>
<li><p><strong>setTransparency</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the color at index 0 should be overwritten with transparent pixels. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code></p></li>
<li><p><strong>layer</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the layer id. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<li><p><strong>useCache</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the image should be saved/loaded using the cache. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. Reading images from a file is slow. Setting <codeclass="docutils literal notranslate"><spanclass="pre">useCache</span></code> to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> will save the image to memory so that the next time the filepath is encountered the image can be loaded from memory rather than the file.</p></li>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)</p></li>
<li><p><strong>tileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – tile value for the image</p></li>
<li><p><strong>xflip</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the tile image is flipped horizontally</p></li>
<li><p><strong>yflip</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the tile image is flipped vertically</p></li>
<li><p><strong>palette</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – palette number for the tile image</p></li>
<li><p><strong>setTransparency</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the color at index 0 should be overwritten with transparent pixels. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code></p></li>
<li><p><strong>layer</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the layer id. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">addTileImage</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tile</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">setTransparency</span><spanclass="pre">=</span><spanclass="pre">false</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#id20"title="Permalink to this definition"></a></dt>
<dd><p>Creates an image of a tile on the specified overlay layer. This is an overloaded function that takes a single tile as a JavaScript object instead of each of the tile’s properties individually.</p>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)</p></li>
<li><p><strong>tile</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">{tileId,xflip,yflip,palette}()</span></code></span>) – the tile to create an image of</p></li>
<li><p><strong>setTransparency</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the color at index 0 should be overwritten with transparent pixels. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code></p></li>
<li><p><strong>layer</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the layer id. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">overlay</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">addMetatileImage</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">y</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">metatileId</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">setTransparency</span><spanclass="pre">=</span><spanclass="pre">false</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">layer</span><spanclass="pre">=</span><spanclass="pre">0</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#overlay.addMetatileImage"title="Permalink to this definition"></a></dt>
<li><p><strong>x</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)</p></li>
<li><p><strong>y</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)</p></li>
<li><p><strong>metatileId</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – id of the metatile to create an image of</p></li>
<li><p><strong>setTransparency</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the color at index 0 should be overwritten with transparent pixels. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code></p></li>
<li><p><strong>layer</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the layer id. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getGridVisibility</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getGridVisibility"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setGridVisibility</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">visible</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.setGridVisibility"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getBorderVisibility</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getBorderVisibility"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setBorderVisibility</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">visible</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.setBorderVisibility"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getSmartPathsEnabled</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getSmartPathsEnabled"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setSmartPathsEnabled</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.setSmartPathsEnabled"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getCustomScripts</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getCustomScripts"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMainTab</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getMainTab"title="Permalink to this definition"></a></dt>
<dd><p>Gets the index of the currently selected main tab. Tabs are indexed from left to right, starting at 0 (<codeclass="docutils literal notranslate"><spanclass="pre">0</span></code>: Map, <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code>: Events, <codeclass="docutils literal notranslate"><spanclass="pre">2</span></code>: Header, <codeclass="docutils literal notranslate"><spanclass="pre">3</span></code>: Connections, <codeclass="docutils literal notranslate"><spanclass="pre">4</span></code>: Wild Pokemon).</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns number</dt>
<ddclass="field-odd"><p>current main tab index</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setMainTab</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">tab</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.setMainTab"title="Permalink to this definition"></a></dt>
<dd><p>Sets the currently selected main tab. Tabs are indexed from left to right, starting at 0 (<codeclass="docutils literal notranslate"><spanclass="pre">0</span></code>: Map, <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code>: Events, <codeclass="docutils literal notranslate"><spanclass="pre">2</span></code>: Header, <codeclass="docutils literal notranslate"><spanclass="pre">3</span></code>: Connections, <codeclass="docutils literal notranslate"><spanclass="pre">4</span></code>: Wild Pokemon).</p>
<li><p><strong>tab</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – index of the tab to select</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMapViewTab</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getMapViewTab"title="Permalink to this definition"></a></dt>
<dd><p>Gets the index of the currently selected map view tab. Tabs are indexed from left to right, starting at 0 (<codeclass="docutils literal notranslate"><spanclass="pre">0</span></code>: Metatiles, <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code>: Collision, <codeclass="docutils literal notranslate"><spanclass="pre">2</span></code>: Prefabs).</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setMapViewTab</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">tab</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.setMapViewTab"title="Permalink to this definition"></a></dt>
<dd><p>Sets the currently selected map view tab. Tabs are indexed from left to right, starting at 0 (<codeclass="docutils literal notranslate"><spanclass="pre">0</span></code>: Metatiles, <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code>: Collision, <codeclass="docutils literal notranslate"><spanclass="pre">2</span></code>: Prefabs).</p>
<li><p><strong>tab</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – index of the tab to select</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMetatileLayerOrder</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getMetatileLayerOrder"title="Permalink to this definition"></a></dt>
<dd><p>Gets the order that metatile layers are rendered.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns array</dt>
<ddclass="field-odd"><p>array of layers. The bottom layer is represented as 0.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setMetatileLayerOrder</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">order</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.setMetatileLayerOrder"title="Permalink to this definition"></a></dt>
<dd><p>Sets the order that metatile layers are rendered.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Arguments</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>order</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of layers. The bottom layer is represented as 0.</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMetatileLayerOpacity</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getMetatileLayerOpacity"title="Permalink to this definition"></a></dt>
<dd><p>Gets the opacities that metatile layers are rendered with.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns array</dt>
<ddclass="field-odd"><p>array of opacities for each layer. The bottom layer is the first element.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setMetatileLayerOpacity</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">opacities</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.setMetatileLayerOpacity"title="Permalink to this definition"></a></dt>
<dd><p>Sets the opacities that metatile layers are rendered with.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Arguments</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>opacities</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – array of opacities for each layer. The bottom layer is the first element.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
<sectionid="utility-functions">
<h4>Utility Functions<aclass="headerlink"href="#utility-functions"title="Permalink to this heading"></a></h4>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">registerAction</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">functionName</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">actionName</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">shortcut</span><spanclass="pre">=</span><spanclass="pre">""</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.registerAction"title="Permalink to this definition"></a></dt>
<dd><p>Registers a JavaScript function to an action that can be manually triggered in Porymap’s <codeclass="docutils literal notranslate"><spanclass="pre">Tools</span></code> menu. Optionally, a keyboard shortcut (e.g. <codeclass="docutils literal notranslate"><spanclass="pre">"Ctrl+P"</span></code>) can also be specified, assuming it doesn’t collide with any existing shortcuts used by Porymap. The function specified by <codeclass="docutils literal notranslate"><spanclass="pre">functionName</span></code> must have the <codeclass="docutils literal notranslate"><spanclass="pre">export</span></code> keyword.</p>
<li><p><strong>functionName</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – name of the JavaScript function</p></li>
<li><p><strong>actionName</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – name of the action that will be displayed in the <codeclass="docutils literal notranslate"><spanclass="pre">Tools</span></code> menu</p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">setTimeout</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">func</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">delayMs</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.setTimeout"title="Permalink to this definition"></a></dt>
<dd><p>This behaves essentially the same as JavaScript’s <codeclass="docutils literal notranslate"><spanclass="pre">setTimeout()</span></code> that is used in web browsers or NodeJS. The <codeclass="docutils literal notranslate"><spanclass="pre">func</span></code> argument is a JavaScript function (NOT the name of a function) which will be executed after a delay. This is useful for creating animations or refreshing the overlay at constant intervals.</p>
<li><p><strong>func</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">function()</span></code></span>) – a JavaScript function that will be executed later</p></li>
<li><p><strong>delayMs</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the number of milliseconds to wait before executing <codeclass="docutils literal notranslate"><spanclass="pre">func</span></code></p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">log</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">message</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.log"title="Permalink to this definition"></a></dt>
<dd><p>Logs a message to the Porymap log file with the prefix <codeclass="docutils literal notranslate"><spanclass="pre">[INFO]</span></code>. This is useful for debugging custom scripts.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">warn</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">message</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.warn"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">error</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">message</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.error"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">showMessage</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">informativeText</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">detailedText</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.showMessage"title="Permalink to this definition"></a></dt>
<dd><p>Displays a message box with an “Information” icon and an <codeclass="docutils literal notranslate"><spanclass="pre">OK</span></code> button. Execution stops while the window is open.</p>
<li><p><strong>text</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the main message text</p></li>
<li><p><strong>informativeText</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – smaller text below the main message. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">""</span></code></p></li>
<li><p><strong>detailedText</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – text hidden behind a “Show Details” box. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">""</span></code></p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">showWarning</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">informativeText</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">detailedText</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.showWarning"title="Permalink to this definition"></a></dt>
<dd><p>Displays a message box with a “Warning” icon and an <codeclass="docutils literal notranslate"><spanclass="pre">OK</span></code> button. Execution stops while the window is open.</p>
<li><p><strong>text</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the main message text</p></li>
<li><p><strong>informativeText</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – smaller text below the main message. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">""</span></code></p></li>
<li><p><strong>detailedText</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – text hidden behind a “Show Details” box. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">""</span></code></p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">showError</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">informativeText</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">detailedText</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.showError"title="Permalink to this definition"></a></dt>
<dd><p>Displays a message box with a “Critical” icon and an <codeclass="docutils literal notranslate"><spanclass="pre">OK</span></code> button. Execution stops while the window is open.</p>
<li><p><strong>text</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the main message text</p></li>
<li><p><strong>informativeText</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – smaller text below the main message. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">""</span></code></p></li>
<li><p><strong>detailedText</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – text hidden behind a “Show Details” box. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">""</span></code></p></li>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">showQuestion</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">informativeText</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">detailedText</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.showQuestion"title="Permalink to this definition"></a></dt>
<dd><p>Displays a message box with a “Question” icon and a <codeclass="docutils literal notranslate"><spanclass="pre">Yes</span></code> and a <codeclass="docutils literal notranslate"><spanclass="pre">No</span></code> button. Execution stops while the window is open.</p>
<li><p><strong>text</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the main message text</p></li>
<li><p><strong>informativeText</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – smaller text below the main message. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">""</span></code></p></li>
<li><p><strong>detailedText</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – text hidden behind a “Show Details” box. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">""</span></code></p></li>
<ddclass="field-even"><p><codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> if <codeclass="docutils literal notranslate"><spanclass="pre">Yes</span></code> was selected, <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> if <codeclass="docutils literal notranslate"><spanclass="pre">No</span></code> was selected or if the window was closed without selection</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getInputText</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">title</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">label</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getInputText"title="Permalink to this definition"></a></dt>
<dd><p>Displays a text input dialog with an <codeclass="docutils literal notranslate"><spanclass="pre">OK</span></code> and a <codeclass="docutils literal notranslate"><spanclass="pre">Cancel</span></code> button. Execution stops while the window is open.</p>
<li><p><strong>title</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the text in the window title bar</p></li>
<li><p><strong>label</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the text adjacent to the input entry area</p></li>
<li><p><strong>default</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the text in the input entry area when the window is opened. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">""</span></code></p></li>
<ddclass="field-even"><p><codeclass="docutils literal notranslate"><spanclass="pre">input</span></code> will be the input text and <codeclass="docutils literal notranslate"><spanclass="pre">ok</span></code> will be <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> if <codeclass="docutils literal notranslate"><spanclass="pre">OK</span></code> was selected. <codeclass="docutils literal notranslate"><spanclass="pre">input</span></code> will be <codeclass="docutils literal notranslate"><spanclass="pre">""</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">ok</span></code> will be <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> if <codeclass="docutils literal notranslate"><spanclass="pre">Cancel</span></code> was selected or if the window was closed without selection.</p>
<dd><p>Displays a number input dialog with an <codeclass="docutils literal notranslate"><spanclass="pre">OK</span></code> and a <codeclass="docutils literal notranslate"><spanclass="pre">Cancel</span></code> button. Execution stops while the window is open.</p>
<li><p><strong>title</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the text in the window title bar</p></li>
<li><p><strong>label</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the text adjacent to the input entry area</p></li>
<li><p><strong>default</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the number in the input entry area when the window is opened. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<li><p><strong>min</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the minimum allowable input value. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">-2147483648</span></code></p></li>
<li><p><strong>max</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the maximum allowable input value. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">2147483647</span></code></p></li>
<li><p><strong>decimals</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the number of decimals used for the input number. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<li><p><strong>step</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the increment by which the input number will change when the spinner is used. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code></p></li>
<ddclass="field-even"><p><codeclass="docutils literal notranslate"><spanclass="pre">input</span></code> will be the input number and <codeclass="docutils literal notranslate"><spanclass="pre">ok</span></code> will be <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> if <codeclass="docutils literal notranslate"><spanclass="pre">OK</span></code> was selected. <codeclass="docutils literal notranslate"><spanclass="pre">input</span></code> will be <codeclass="docutils literal notranslate"><spanclass="pre">default</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">ok</span></code> will be <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> if <codeclass="docutils literal notranslate"><spanclass="pre">Cancel</span></code> was selected or if the window was closed without selection.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getInputItem</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">title</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">label</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">items</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">editable</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getInputItem"title="Permalink to this definition"></a></dt>
<dd><p>Displays a text input dialog with an items dropdown and an <codeclass="docutils literal notranslate"><spanclass="pre">OK</span></code> and a <codeclass="docutils literal notranslate"><spanclass="pre">Cancel</span></code> button. Execution stops while the window is open.</p>
<li><p><strong>title</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the text in the window title bar</p></li>
<li><p><strong>label</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">string()</span></code></span>) – the text adjacent to the input entry area</p></li>
<li><p><strong>items</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">array()</span></code></span>) – an array of text items that will populate the dropdown</p></li>
<li><p><strong>default</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">number()</span></code></span>) – the index of the item to select by default. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code></p></li>
<li><p><strong>editable</strong> (<span><codeclass="xref js js-func docutils literal notranslate"><spanclass="pre">boolean()</span></code></span>) – whether the user is allowed to enter their own text instead. Defaults to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code></p></li>
<ddclass="field-even"><p><codeclass="docutils literal notranslate"><spanclass="pre">input</span></code> will be the input text and <codeclass="docutils literal notranslate"><spanclass="pre">ok</span></code> will be <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> if <codeclass="docutils literal notranslate"><spanclass="pre">OK</span></code> was selected. <codeclass="docutils literal notranslate"><spanclass="pre">input</span></code> will be the text of the item at <codeclass="docutils literal notranslate"><spanclass="pre">default</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">ok</span></code> will be <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> if <codeclass="docutils literal notranslate"><spanclass="pre">Cancel</span></code> was selected or if the window was closed without selection.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMapNames</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getMapNames"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getTilesetNames</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getTilesetNames"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getPrimaryTilesetNames</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getPrimaryTilesetNames"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getSecondaryTilesetNames</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getSecondaryTilesetNames"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMetatileBehaviorNames</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getMetatileBehaviorNames"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getSongNames</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getSongNames"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getLocationNames</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getLocationNames"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getWeatherNames</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getWeatherNames"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getMapTypeNames</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getMapTypeNames"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">getBattleSceneNames</span></span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.getBattleSceneNames"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">isPrimaryTileset</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">tilesetName</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.isPrimaryTileset"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">utility</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">isSecondaryTileset</span></span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">tilesetName</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#utility.isSecondaryTileset"title="Permalink to this definition"></a></dt>
<p>Some constant values are provided for convenience. These are read-only properties guaranteed not to change unless a new project is opened or the current one is reloaded.</p>
<p>All constants are accessible via the global <codeclass="docutils literal notranslate"><spanclass="pre">constants</span></code> object.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">constants</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">max_primary_tiles</span></span></span><aclass="headerlink"href="#constants.max_primary_tiles"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">constants</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">max_secondary_tiles</span></span></span><aclass="headerlink"href="#constants.max_secondary_tiles"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">constants</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">max_primary_metatiles</span></span></span><aclass="headerlink"href="#constants.max_primary_metatiles"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">constants</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">max_secondary_metatiles</span></span></span><aclass="headerlink"href="#constants.max_secondary_metatiles"title="Permalink to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">constants</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">layers_per_metatile</span></span></span><aclass="headerlink"href="#constants.layers_per_metatile"title="Permalink to this definition"></a></dt>
<dd><p>The number of tile layers used in each metatile. This will either be <codeclass="docutils literal notranslate"><spanclass="pre">2</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">3</span></code>, depending on the config setting <codeclass="docutils literal notranslate"><spanclass="pre">enable_triple_layer_metatiles</span></code>.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">constants</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">tiles_per_metatile</span></span></span><aclass="headerlink"href="#constants.tiles_per_metatile"title="Permalink to this definition"></a></dt>
<dd><p>The number of tiles in each metatile. This will either be <codeclass="docutils literal notranslate"><spanclass="pre">8</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">12</span></code>, depending on the config setting <codeclass="docutils literal notranslate"><spanclass="pre">enable_triple_layer_metatiles</span></code>.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">constants</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">base_game_version</span></span></span><aclass="headerlink"href="#constants.base_game_version"title="Permalink to this definition"></a></dt>
<dd><p>The string value of the config setting <codeclass="docutils literal notranslate"><spanclass="pre">base_game_version</span></code>. This will either be <codeclass="docutils literal notranslate"><spanclass="pre">pokeruby</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">pokefirered</span></code>, or <codeclass="docutils literal notranslate"><spanclass="pre">pokeemerald</span></code>.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">constants</span></span><spanclass="p"><spanclass="pre">.</span></span><spanclass="n"><spanclass="pre">version</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">major</span></span></span><aclass="headerlink"href="#constants.version.major"title="Permalink to this definition"></a></dt>
<dd><p>Porymap’s major version number. For example, for Porymap version <codeclass="docutils literal notranslate"><spanclass="pre">5.0.1</span></code> this will be <codeclass="docutils literal notranslate"><spanclass="pre">5</span></code>.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">constants</span></span><spanclass="p"><spanclass="pre">.</span></span><spanclass="n"><spanclass="pre">version</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">minor</span></span></span><aclass="headerlink"href="#constants.version.minor"title="Permalink to this definition"></a></dt>
<dd><p>Porymap’s minor version number. For example, for Porymap version <codeclass="docutils literal notranslate"><spanclass="pre">5.0.1</span></code> this will be <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code>.</p>
<spanclass="sig-prename descclassname"><spanclass="n"><spanclass="pre">constants</span></span><spanclass="p"><spanclass="pre">.</span></span><spanclass="n"><spanclass="pre">version</span></span><spanclass="p"><spanclass="pre">.</span></span></span><spanclass="sig-name descname"><spanclass="n"><spanclass="pre">patch</span></span></span><aclass="headerlink"href="#constants.version.patch"title="Permalink to this definition"></a></dt>
<dd><p>Porymap’s patch version number. For example, for Porymap version <codeclass="docutils literal notranslate"><spanclass="pre">5.0.1</span></code> this will be <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code>.</p>
