porymap/docs/manual/project-files.html
2024-01-15 17:26:47 -05:00

1008 lines
No EOL
56 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Project Files &mdash; porymap documentation</title>
<link rel="shortcut icon" href="../_static/porymap-icon-2.ico"/>
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Shortcuts" href="shortcuts.html" />
<link rel="prev" title="Scripting Capabilities" href="scripting-capabilities.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
<a href="../index.html" class="icon icon-home"> porymap
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">User Manual</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#about-porymap">About Porymap</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#getting-started">Getting Started</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="navigation.html">Navigation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="navigation.html#map-list">Map List</a></li>
<li class="toctree-l2"><a class="reference internal" href="navigation.html#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="navigation.html#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="navigation.html#region-map-editor">Region Map Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-tiles.html">Editing Map Tiles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#visual-options">Visual Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#selecting-metatiles">Selecting Metatiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pencil-tool">Pencil Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pointer-tool">Pointer Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#bucket-fill-tool">Bucket Fill Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#map-shift-tool">Map Shift Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#smart-paths">Smart Paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#straight-paths">Straight Paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-collisions.html">Editing Map Collisions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#selecting-collision-types">Selecting Collision Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#painting-collisions">Painting Collisions</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#collision-types">Collision Types</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#clone-object-events">Clone Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#sign-event">Sign Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#secret-base-event">Secret Base Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#ruler-tool">Ruler Tool</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-connections.html">Editing Map Connections</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#follow-connections">Follow Connections</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-wild-encounters.html">Editing Wild Encounters</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#adding-new-encounter-groups">Adding New Encounter Groups</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a><ul>
<li class="toctree-l2"><a class="reference internal" href="creating-new-maps.html#new-map-options">New Map Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-entries-tab">Map Entries Tab</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#palette-editor">Palette Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#custom-scripts-editor">Custom Scripts Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#scripting-api">Scripting API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-header-editing-functions">Map Header Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#overlay-functions">Overlay Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#settings-functions">Settings Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#utility-functions">Utility Functions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#constants">Constants</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Project Files</a></li>
<li class="toctree-l1"><a class="reference internal" href="shortcuts.html">Shortcuts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#region-map-editor">Region Map Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a><ul>
<li class="toctree-l2"><a class="reference internal" href="settings-and-options.html#global-settings">Global settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings-and-options.html#project-settings">Project settings</a><ul>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#general">General</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#maps">Maps</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#tilesets">Tilesets</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#files-identifiers">Files &amp; Identifiers</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">5.3.0 - 2024-01-15</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">5.2.0 - 2024-01-02</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">5.1.1 - 2023-02-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id10">5.1.0 - 2023-01-22</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id14">5.0.0 - 2022-10-30</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id22">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id28">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id30">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id33">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id34">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id37">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id38">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id41">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id43">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id45">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id46">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id47">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id49">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id54">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id55">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id56">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id57">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id58">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id59">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id60">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id61">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id62">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id63">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id64">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id65">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id66">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id67">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id68">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id69">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id70">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id71">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id72">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id73">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id74">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id75">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id76">1.0.0 - 2018-10-26</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">porymap</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> &raquo;</li>
<li>Project Files</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/manual/project-files.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="project-files">
<h1>Project Files<a class="headerlink" href="#project-files" title="Permalink to this headline"></a></h1>
<p>Porymap relies on the user maintaining a certain level of integrity with their project files.
This is a list of files that porymap reads from and writes to. Generally, if porymap writes
to a file, it probably is not a good idea to edit yourself unless otherwise noted.</p>
<p>The filepath that Porymap expects for each file can be overridden on the <code class="docutils literal notranslate"><span class="pre">Files</span></code> tab of <code class="docutils literal notranslate"><span class="pre">Options</span> <span class="pre">-&gt;</span> <span class="pre">Project</span> <span class="pre">Settings</span></code>. A new path can be specified by entering it in the text box or choosing it with the <a class="reference internal" href="../_images/folder.png"><img alt="button-folder" src="../_images/folder.png" style="width: 24px; height: 24px;" /></a> button. Paths are expected to be relative to the root project folder. If no path is specified, or if the file/folder specified does not exist, then the default path will be used instead. The name of each setting in this section is listed in the table below under <code class="docutils literal notranslate"><span class="pre">Override</span></code>.</p>
<div class="figure">
<img alt="Files tab" src="../_images/tab-files.png" />
</div>
<table border="1" class="colwidths-given docutils" id="files">
<colgroup>
<col width="25%" />
<col width="6%" />
<col width="6%" />
<col width="25%" />
<col width="38%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">File Name</th>
<th class="head">Read</th>
<th class="head">Write</th>
<th class="head">Override</th>
<th class="head">Notes</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>data/maps/*/map.json</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">data_map_folders</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>data/maps/*/scripts.[inc|pory]</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">data_map_folders</span></code></td>
<td>for finding script labels</td>
</tr>
<tr class="row-even"><td>data/scripts/*.[inc|pory]</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">data_scripts_folders</span></code></td>
<td>for finding script labels</td>
</tr>
<tr class="row-odd"><td>data/event_scripts.s</td>
<td>no</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">data_event_scripts</span></code></td>
<td>only appends new script files to end of file</td>
</tr>
<tr class="row-even"><td>data/maps/map_groups.json</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">json_map_groups</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>data/layouts/layouts.json</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">json_layouts</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>data/layouts/*/[border|map].bin</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">data_layouts_folders</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>src/data/tilesets/headers.h</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">tilesets_headers</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>src/data/tilesets/graphics.h</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">tilesets_graphics</span></code></td>
<td>also edits palette and tile image files listed in this file</td>
</tr>
<tr class="row-odd"><td>src/data/tilesets/metatiles.h</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">tilesets_metatiles</span></code></td>
<td>also edits metatile files listed in this file</td>
</tr>
<tr class="row-even"><td>data/tilesets/headers.inc</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">tilesets_headers_asm</span></code></td>
<td>only if <code class="docutils literal notranslate"><span class="pre">tilesets_headers</span></code> cant be found</td>
</tr>
<tr class="row-odd"><td>data/tilesets/graphics.inc</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">tilesets_graphics_asm</span></code></td>
<td>only if <code class="docutils literal notranslate"><span class="pre">tilesets_headers</span></code> cant be found</td>
</tr>
<tr class="row-even"><td>data/tilesets/metatiles.inc</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">tilesets_metatiles_asm</span></code></td>
<td>only if <code class="docutils literal notranslate"><span class="pre">tilesets_headers</span></code> cant be found</td>
</tr>
<tr class="row-odd"><td>data/tilesets/[primary|secondary]/*</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">data_tilesets_folders</span></code></td>
<td>default tileset data location</td>
</tr>
<tr class="row-even"><td>src/data/wild_encounters.json</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">json_wild_encounters</span></code></td>
<td>optional (only required to use Wild Pokémon tab)</td>
</tr>
<tr class="row-odd"><td>src/data/object_events/object_event_graphics_info_pointers.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">data_obj_event_gfx_pointers</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>src/data/object_events/object_event_graphics_info.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">data_obj_event_gfx_info</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>src/data/object_events/object_event_pic_tables.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">data_obj_event_pic_tables</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>src/data/object_events/object_event_graphics.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">data_obj_event_gfx</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>src/data/graphics/pokemon.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">data_pokemon_gfx</span></code></td>
<td>for pokemon sprite icons</td>
</tr>
<tr class="row-even"><td>src/data/heal_locations.h</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">data_heal_locations</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>src/data/region_map/region_map_sections.json</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">json_region_map_entries</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>src/data/region_map/porymap_config.json</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">json_region_porymap_cfg</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>include/constants/global.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_global</span></code></td>
<td>reads <code class="docutils literal notranslate"><span class="pre">define_obj_event_count</span></code></td>
</tr>
<tr class="row-even"><td>include/constants/map_groups.h</td>
<td>no</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_map_groups</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>include/constants/items.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_items</span></code></td>
<td>for Hidden Item events</td>
</tr>
<tr class="row-even"><td>include/constants/flags.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_flags</span></code></td>
<td>for Object and Hidden Item events</td>
</tr>
<tr class="row-odd"><td>include/constants/vars.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_vars</span></code></td>
<td>for Trigger events</td>
</tr>
<tr class="row-even"><td>include/constants/weather.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_weather</span></code></td>
<td>for map weather and Weather Triggers</td>
</tr>
<tr class="row-odd"><td>include/constants/songs.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_songs</span></code></td>
<td>for map music</td>
</tr>
<tr class="row-even"><td>include/constants/heal_locations.h</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_heal_locations</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>include/constants/pokemon.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_pokemon</span></code></td>
<td>reads <code class="docutils literal notranslate"><span class="pre">define_min_level</span></code> and <code class="docutils literal notranslate"><span class="pre">define_max_level</span></code></td>
</tr>
<tr class="row-even"><td>include/constants/map_types.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_map_types</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>include/constants/trainer_types.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_trainer_types</span></code></td>
<td>for Object events</td>
</tr>
<tr class="row-even"><td>include/constants/secret_bases.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_secret_bases</span></code></td>
<td>pokeemerald and pokeruby only</td>
</tr>
<tr class="row-odd"><td>include/constants/event_object_movement.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_obj_event_movement</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>include/constants/event_objects.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_obj_events</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>include/constants/event_bg.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_event_bg</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>include/constants/region_map_sections.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_region_map_sections</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>include/constants/metatile_labels.h</td>
<td>yes</td>
<td>yes</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_metatile_labels</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>include/constants/metatile_behaviors.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_metatile_behaviors</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>include/constants/species.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_metatile_behaviors</span></code></td>
<td>for the Wild Pokémon tab</td>
</tr>
<tr class="row-even"><td>include/global.fieldmap.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">global_fieldmap</span></code></td>
<td>reads map and tileset data masks</td>
</tr>
<tr class="row-odd"><td>include/fieldmap.h</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">constants_fieldmap</span></code></td>
<td>reads tileset related constants</td>
</tr>
<tr class="row-even"><td>src/fieldmap.c</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">fieldmap</span></code></td>
<td>reads <code class="docutils literal notranslate"><span class="pre">symbol_attribute_table</span></code></td>
</tr>
<tr class="row-odd"><td>src/event_object_movement.c</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">initial_facing_table</span></code></td>
<td>reads <code class="docutils literal notranslate"><span class="pre">symbol_facing_directions</span></code></td>
</tr>
<tr class="row-even"><td>src/pokemon_icon.c</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">pokemon_icon_table</span></code></td>
<td>reads files in <code class="docutils literal notranslate"><span class="pre">symbol_pokemon_icon_table</span></code></td>
</tr>
<tr class="row-odd"><td>graphics/pokemon/*/icon.png</td>
<td>yes</td>
<td>no</td>
<td><code class="docutils literal notranslate"><span class="pre">pokemon_gfx</span></code></td>
<td>to search for Pokémon icons if they arent found in <code class="docutils literal notranslate"><span class="pre">symbol_pokemon_icon_table</span></code></td>
</tr>
</tbody>
</table>
<p>In addition to these files, there are some specific symbol and macro names that Porymap expects to find in your project. These can be overridden on the <code class="docutils literal notranslate"><span class="pre">Identifiers</span></code> tab of <code class="docutils literal notranslate"><span class="pre">Options</span> <span class="pre">-&gt;</span> <span class="pre">Project</span> <span class="pre">Settings</span></code>. The name of each setting in this section is listed in the table below under <code class="docutils literal notranslate"><span class="pre">Override</span></code>. Overrides with <code class="docutils literal notranslate"><span class="pre">regex</span></code> in the name support the <a class="reference external" href="https://perldoc.perl.org/perlre">regular expression syntax</a> used by Qt.</p>
<div class="figure">
<img alt="Files tab" src="../_images/tab-identifiers.png" />
</div>
<table border="1" class="colwidths-given docutils" id="identifiers">
<colgroup>
<col width="29%" />
<col width="29%" />
<col width="43%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Override</th>
<th class="head">Default</th>
<th class="head">Notes</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">symbol_facing_directions</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">gInitialMovementTypeFacingDirections</span></code></td>
<td>to set sprite frame for Object Events based on movement type</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">symbol_obj_event_gfx_pointers</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">gObjectEventGraphicsInfoPointers</span></code></td>
<td>to map Object Event graphics IDs to graphics data</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">symbol_pokemon_icon_table</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">gMonIconTable</span></code></td>
<td>to map species constants to icon images</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">symbol_wild_encounters</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">gWildMonHeaders</span></code></td>
<td>output as the <code class="docutils literal notranslate"><span class="pre">label</span></code> property for the top-level wild ecounters JSON object</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">symbol_heal_locations_type</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">struct</span> <span class="pre">HealLocation</span></code></td>
<td>the type for the Heal Locations table</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">symbol_heal_locations</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">sHealLocations</span></code></td>
<td>the default Heal Locations table name when <code class="docutils literal notranslate"><span class="pre">Respawn</span> <span class="pre">Map/NPC</span></code> is disabled</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">symbol_spawn_points</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">sSpawnPoints</span></code></td>
<td>the default Heal Locations table name when <code class="docutils literal notranslate"><span class="pre">Respawn</span> <span class="pre">Map/NPC</span></code> is enabled</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">symbol_spawn_maps</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">u16</span> <span class="pre">sWhiteoutRespawnHealCenterMapIdxs</span></code></td>
<td>the type and table name for Heal Location <code class="docutils literal notranslate"><span class="pre">Respawn</span> <span class="pre">Map</span></code> values</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">symbol_spawn_npcs</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">u8</span> <span class="pre">sWhiteoutRespawnHealerNpcIds</span></code></td>
<td>the type and table name for Heal Location <code class="docutils literal notranslate"><span class="pre">Respawn</span> <span class="pre">NPC</span></code> values</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">symbol_attribute_table</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">sMetatileAttrMasks</span></code></td>
<td>optionally read to get settings on <code class="docutils literal notranslate"><span class="pre">Tilesets</span></code> tab</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">symbol_tilesets_prefix</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">gTileset_</span></code></td>
<td>for new tileset names and to extract base tileset names</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_obj_event_count</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">OBJECT_EVENT_TEMPLATES_COUNT</span></code></td>
<td>to limit total Object Events</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">define_min_level</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">MIN_LEVEL</span></code></td>
<td>minimum wild encounters level</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_max_level</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">MAX_LEVEL</span></code></td>
<td>maximum wild encounters level</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">define_tiles_primary</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">NUM_TILES_IN_PRIMARY</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_tiles_total</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">NUM_TILES_TOTAL</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">define_metatiles_primary</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">NUM_METATILES_IN_PRIMARY</span></code></td>
<td>total metatiles are calculated using metatile ID mask</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_pals_primary</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">NUM_PALS_IN_PRIMARY</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">define_pals_total</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">NUM_PALS_TOTAL</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_map_size</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">MAX_MAP_DATA_SIZE</span></code></td>
<td>to limit map dimensions</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">define_mask_metatile</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">MAPGRID_METATILE_ID_MASK</span></code></td>
<td>optionally read to get settings on <code class="docutils literal notranslate"><span class="pre">Maps</span></code> tab</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_mask_collision</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">MAPGRID_COLLISION_MASK</span></code></td>
<td>optionally read to get settings on <code class="docutils literal notranslate"><span class="pre">Maps</span></code> tab</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">define_mask_elevation</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">MAPGRID_ELEVATION_MASK</span></code></td>
<td>optionally read to get settings on <code class="docutils literal notranslate"><span class="pre">Maps</span></code> tab</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_mask_behavior</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">METATILE_ATTR_BEHAVIOR_MASK</span></code></td>
<td>optionally read to get settings on <code class="docutils literal notranslate"><span class="pre">Tilesets</span></code> tab</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">define_mask_layer</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">METATILE_ATTR_LAYER_MASK</span></code></td>
<td>optionally read to get settings on <code class="docutils literal notranslate"><span class="pre">Tilesets</span></code> tab</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_attribute_behavior</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">METATILE_ATTRIBUTE_BEHAVIOR</span></code></td>
<td>name used to extract setting from <code class="docutils literal notranslate"><span class="pre">symbol_attribute_table</span></code></td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">define_attribute_layer</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">METATILE_ATTRIBUTE_LAYER_TYPE</span></code></td>
<td>name used to extract setting from <code class="docutils literal notranslate"><span class="pre">symbol_attribute_table</span></code></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_attribute_terrain</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">METATILE_ATTRIBUTE_TERRAIN</span></code></td>
<td>name used to extract setting from <code class="docutils literal notranslate"><span class="pre">symbol_attribute_table</span></code></td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">define_attribute_encounter</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">METATILE_ATTRIBUTE_ENCOUNTER_TYPE</span></code></td>
<td>name used to extract setting from <code class="docutils literal notranslate"><span class="pre">symbol_attribute_table</span></code></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_metatile_label_prefix</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">METATILE_</span></code></td>
<td>expected prefix for metatile label macro names</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">define_heal_locations_prefix</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">HEAL_LOCATION_</span></code></td>
<td>output as prefix for Heal Location IDs if <code class="docutils literal notranslate"><span class="pre">Respawn</span> <span class="pre">Map/NPC</span></code> is disabled</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_spawn_prefix</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">SPAWN_</span></code></td>
<td>output as prefix for Heal Location IDs if <code class="docutils literal notranslate"><span class="pre">Respawn</span> <span class="pre">Map/NPC</span></code> is enabled</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">define_map_prefix</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">MAP_</span></code></td>
<td>expected prefix for map macro names</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_map_dynamic</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">DYNAMIC</span></code></td>
<td>macro name after prefix for Dynamic maps</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">define_map_empty</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">UNDEFINED</span></code></td>
<td>macro name after prefix for empty maps</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_map_section_prefix</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">MAPSEC_</span></code></td>
<td>expected prefix for location macro names</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">define_map_section_empty</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">NONE</span></code></td>
<td>macro name after prefix for empty region map sections</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">define_map_section_count</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">COUNT</span></code></td>
<td>macro name after prefix for total number of region map sections</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regex_behaviors</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bMB_</span></code></td>
<td>regex to find metatile behavior macro names</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regex_obj_event_gfx</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bOBJ_EVENT_GFX_</span></code></td>
<td>regex to find Object Event graphics ID macro names</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regex_items</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bITEM_(?!(B_)?USE_)</span></code></td>
<td>regex to find item macro names</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regex_flags</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bFLAG_</span></code></td>
<td>regex to find flag macro names</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regex_vars</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bVAR_</span></code></td>
<td>regex to find var macro names</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regex_movement_types</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bMOVEMENT_TYPE_</span></code></td>
<td>regex to find movement type macro names</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regex_map_types</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bMAP_TYPE_</span></code></td>
<td>regex to find map type macro names</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regex_battle_scenes</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bMAP_BATTLE_SCENE_</span></code></td>
<td>regex to find battle scene macro names</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regex_weather</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bWEATHER_</span></code></td>
<td>regex to find map weather macro names</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regex_coord_event_weather</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bCOORD_EVENT_WEATHER_</span></code></td>
<td>regex to find weather trigger macro names</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regex_secret_bases</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bSECRET_BASE_[A-Za-z0-9_]*_[0-9]+</span></code></td>
<td>regex to find secret base ID macro names</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regex_sign_facing_directions</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bBG_EVENT_PLAYER_FACING_</span></code></td>
<td>regex to find sign facing direction macro names</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regex_trainer_types</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bTRAINER_TYPE_</span></code></td>
<td>regex to find trainer type macro names</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regex_music</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\b(SE|MUS)_</span></code></td>
<td>regex to find music macro names</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regex_species</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">\bSPECIES_</span></code></td>
<td>regex to find species macro names</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="shortcuts.html" class="btn btn-neutral float-right" title="Shortcuts" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="scripting-capabilities.html" class="btn btn-neutral float-left" title="Scripting Capabilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2023, huderlem
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>