atiran/porymap
3
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Add map connections editing docs

Browse source
This commit is contained in:
Marcus Huderle 2019-04-27 13:43:41 -05:00
parent e1e44dab81
commit 099b197452
26 changed files with 474 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/_images/add-connection-button.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 890 B

BIN
docs/_images/map-connections.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 114 KiB

BIN
docs/_images/remove-connection-button.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 916 B

1
docs/_sources/index.rst.txt
View file

@ -14,6 +14,7 @@ Porymap Documentation
manual/editing-map-collisions
manual/editing-map-events
manual/editing-map-header
manual/editing-map-connections
.. toctree::
:maxdepth: 2

36
docs/_sources/manual/editing-map-connections.rst.txt Normal file
View file

@ -0,0 +1,36 @@
***********************
Editing Map Connections
***********************
Maps can be connected together so that the player can seamlessly walk between them. These connections can be edited in the Connections tab.
.. figure:: images/editing-map-connections/map-connections.png
:alt: Map Connections View
Map Connections View
A connection has a direction, offset, and destination map. To add new connection, press the plus button |add-connection-button|. To delete a connection, select it and press the delete button |remove-connection-button|.
.. |add-connection-button|
image:: images/editing-map-connections/add-connection-button.png
.. |remove-connection-button|
image:: images/editing-map-connections/remove-connection-button.png
To change the connection's vertical or horizontal offset, it's easiest to click and drag the connection to the desired offset.
Dive & Emerge Warps
-------------------
Dive & emerge warps are used for the HM move Dive. They don't have offsets or directions--only a destination map. To add a dive or emerge warp, simply add a value in the Dive Map and/or Emerge Map dropdown menus.
Mirror Connections
------------------
An extremely useful feature is the *Mirror to Connecting Maps* checkbox in the top-right corner. Connections are one-way, which means that you must keep the two connections in sync between the two maps. For example, Petalburg City has a west connection to Route 104, and Route 104 has an east connection to Petalburg City. If *Mirror to Connecting Maps* is enabled, then Porymap will automatically update both sides of the connection. Be sure to *File -> Save All* (``Ctrl+Shift+S``) when saving, since you will need to save both maps' connections.
Follow Connections
------------------
Double-clicking on a connection will open the destination map. This is very useful for navigating through your maps, similar to double-clicking on :ref:`Event Warps <event-warps>`.

2
docs/_sources/manual/editing-map-events.rst.txt
View file

@ -70,6 +70,8 @@ Trainer Type
Sight Radius or Berry Tree ID
If the object is a trainer, this property control how many tiles the trainer can see to spot the player for battle. If the object is a berry tree, this specifies the global id of the berry tree. Each berry tree in the game has a unique berry tree id.
.. _event-warps:
Event Warps
-----------

6
docs/genindex.html
View file

@ -127,6 +127,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-connections.html">Editing Map Connections</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#follow-connections">Follow Connections</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>

12
docs/index.html
View file

@ -127,6 +127,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-connections.html">Editing Map Connections</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#follow-connections">Follow Connections</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
@ -280,6 +286,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-connections.html">Editing Map Connections</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#follow-connections">Follow Connections</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">

6
docs/manual/editing-map-collisions.html
View file

@ -128,6 +128,12 @@
</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>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>

308
docs/manual/editing-map-connections.html Normal file
View file

@ -0,0 +1,308 @@
<!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>Editing Map Connections &mdash; porymap documentation</title>
<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="Changelog" href="../reference/changelog.html" />
<link rel="prev" title="Editing Map Headers" href="editing-map-header.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#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>
</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#events-positions">Events Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
<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#open-map-scripts">Open Map Scripts</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 current"><a class="current reference internal" href="#">Editing Map Connections</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="#mirror-connections">Mirror Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="#follow-connections">Follow Connections</a></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><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#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">1.2.0 - 2019-02-04</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#id5">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">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>Editing Map Connections</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/manual/editing-map-connections.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="editing-map-connections">
<h1>Editing Map Connections<a class="headerlink" href="#editing-map-connections" title="Permalink to this headline"></a></h1>
<p>Maps can be connected together so that the player can seamlessly walk between them. These connections can be edited in the Connections tab.</p>
<div class="figure" id="id1">
<img alt="Map Connections View" src="../_images/map-connections.png" />
<p class="caption"><span class="caption-text">Map Connections View</span></p>
</div>
<p>A connection has a direction, offset, and destination map. To add new connection, press the plus button <img alt="add-connection-button" src="../_images/add-connection-button.png" />. To delete a connection, select it and press the delete button <img alt="remove-connection-button" src="../_images/remove-connection-button.png" />.</p>
<p>To change the connection’s vertical or horizontal offset, it’s easiest to click and drag the connection to the desired offset.</p>
<div class="section" id="dive-emerge-warps">
<h2>Dive &amp; Emerge Warps<a class="headerlink" href="#dive-emerge-warps" title="Permalink to this headline"></a></h2>
<p>Dive &amp; emerge warps are used for the HM move Dive. They don’t have offsets or directions–only a destination map. To add a dive or emerge warp, simply add a value in the Dive Map and/or Emerge Map dropdown menus.</p>
</div>
<div class="section" id="mirror-connections">
<h2>Mirror Connections<a class="headerlink" href="#mirror-connections" title="Permalink to this headline"></a></h2>
<p>An extremely useful feature is the <em>Mirror to Connecting Maps</em> checkbox in the top-right corner. Connections are one-way, which means that you must keep the two connections in sync between the two maps. For example, Petalburg City has a west connection to Route 104, and Route 104 has an east connection to Petalburg City. If <em>Mirror to Connecting Maps</em> is enabled, then Porymap will automatically update both sides of the connection. Be sure to <em>File -&gt; Save All</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl+Shift+S</span></code>) when saving, since you will need to save both maps’ connections.</p>
</div>
<div class="section" id="follow-connections">
<h2>Follow Connections<a class="headerlink" href="#follow-connections" title="Permalink to this headline"></a></h2>
<p>Double-clicking on a connection will open the destination map. This is very useful for navigating through your maps, similar to double-clicking on <a class="reference internal" href="editing-map-events.html#event-warps"><span class="std std-ref">Event Warps</span></a>.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../reference/changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="editing-map-header.html" class="btn btn-neutral float-left" title="Editing Map Headers" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2019, 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>

28
docs/manual/editing-map-events.html
View file

@ -128,6 +128,12 @@
</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>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
@ -230,12 +236,12 @@
<div class="section" id="editing-map-events">
<h1>Editing Map Events<a class="headerlink" href="#editing-map-events" title="Permalink to this headline"></a></h1>
<p>Events are what bring your maps to life. They include NPCs, signposts, warps, scripts, and more. Open the <em>Events</em> tab above the map area, and let’s dissect what’s going on.</p>
<div class="figure" id="id1">
<div class="figure" id="id2">
<img alt="Map Events View" src="../_images/map-events.png" />
<p class="caption"><span class="caption-text">Map Events View</span></p>
</div>
<p>All of the events are visible on the map. The Event Details window on the right displays the properties of the currently-selected event. If you look closely, you’ll see that the woman NPC near the Pokémon Center has a pink border around it because it’s selected. To select a different event, simple click on an event in the map area. Alternatively, you can use the spinner at the top of the event properties window. Multiple events can be selected at the same time by holding <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> and clicking another event.</p>
<div class="figure" id="id2">
<div class="figure" id="id3">
<img alt="Event Id Spinner" src="../_images/event-id-spinner.png" />
<p class="caption"><span class="caption-text">Event Id Spinner</span></p>
</div>
@ -246,7 +252,7 @@
<div class="section" id="events-positions">
<h2>Events Positions<a class="headerlink" href="#events-positions" title="Permalink to this headline"></a></h2>
<p>All events have X/Y coordinates. To move an Event, click and drag it to a new position on the map. Alternatively, you can use the X and Y spinners in the event properties.</p>
<div class="figure" id="id3">
<div class="figure" id="id4">
<img alt="Event Coordinates Spinners" src="../_images/event-coords-spinners.png" />
<p class="caption"><span class="caption-text">Event Coordinates Spinners</span></p>
</div>
@ -256,7 +262,7 @@
<div class="section" id="event-objects">
<h2>Event Objects<a class="headerlink" href="#event-objects" title="Permalink to this headline"></a></h2>
<p>Event objects are typically used for NPCs (non-player-characters). More technically, it’s any event that has a sprite and the ability to move around. Event objects are displayed using their assigned sprite, except for special cases. Any event object that uses a dynamic sprite will be displayed as a blue square with an <cite>N</cite> <img alt="dynamic-sprite" src="../_images/dynamic-sprite.png" />. Some examples of dynamic sprites are the player’s rival and berry trees.</p>
<div class="figure" id="id4">
<div class="figure" id="id5">
<img alt="Event Object Properties" src="../_images/event-object.png" />
<p class="caption"><span class="caption-text">Event Object Properties</span></p>
</div>
@ -280,9 +286,9 @@
</dl>
</div>
<div class="section" id="event-warps">
<h2>Event Warps<a class="headerlink" href="#event-warps" title="Permalink to this headline"></a></h2>
<span id="id1"></span><h2>Event Warps<a class="headerlink" href="#event-warps" title="Permalink to this headline"></a></h2>
<p>Event warps are how the player is able to warp to other maps, such as entering a building. Double-clicking on a warp will automatically open the destination map and select the destination warp. This makes it very easy to navigate around in Porymap.</p>
<div class="figure" id="id5">
<div class="figure" id="id6">
<img alt="Event Warp Properties" src="../_images/event-warp.png" />
<p class="caption"><span class="caption-text">Event Warp Properties</span></p>
</div>
@ -298,7 +304,7 @@
<div class="section" id="event-triggers">
<h2>Event Triggers<a class="headerlink" href="#event-triggers" title="Permalink to this headline"></a></h2>
<p>Event triggers are scripts that execute when the player walks over them. However, they only execute when a variable is equal some value. Typically, they execute once, set the variable’s value to something else, and then never execute again because the variable’s value no longer matches.</p>
<div class="figure" id="id6">
<div class="figure" id="id7">
<img alt="Event Trigger Properties" src="../_images/event-trigger.png" />
<p class="caption"><span class="caption-text">Event Trigger Properties</span></p>
</div>
@ -316,7 +322,7 @@
<div class="section" id="event-weather-triggers">
<h2>Event Weather Triggers<a class="headerlink" href="#event-weather-triggers" title="Permalink to this headline"></a></h2>
<p>Event weather triggers are a very specific type of trigger. When the player walks over a weather trigger, the overworld’s weather will transition to the specified weather type.</p>
<div class="figure" id="id7">
<div class="figure" id="id8">
<img alt="Event Weather Trigger Properties" src="../_images/event-weather-trigger.png" />
<p class="caption"><span class="caption-text">Event Weather Trigger Properties</span></p>
</div>
@ -330,7 +336,7 @@
<div class="section" id="event-signs">
<h2>Event Signs<a class="headerlink" href="#event-signs" title="Permalink to this headline"></a></h2>
<p>Event signs, or signposts, are simple interactable scripts. They are typically used for things like signs in front of buildings. The player’s facing direction can be required to be a certain direction in order to interact with the sign. Signs are the first of three “BG” event types.</p>
<div class="figure" id="id8">
<div class="figure" id="id9">
<img alt="Event Sign Properties" src="../_images/event-sign.png" />
<p class="caption"><span class="caption-text">Event Sign Properties</span></p>
</div>
@ -346,7 +352,7 @@
<div class="section" id="event-hidden-item">
<h2>Event Hidden Item<a class="headerlink" href="#event-hidden-item" title="Permalink to this headline"></a></h2>
<p>Hidden items are invisible items that can be picked up by the player. They each use a flag to ensure the item can only be picked up once.</p>
<div class="figure" id="id9">
<div class="figure" id="id10">
<img alt="Event Hidden Item Properties" src="../_images/event-hidden-item.png" />
<p class="caption"><span class="caption-text">Event Hidden Item Properties</span></p>
</div>
@ -362,7 +368,7 @@
<div class="section" id="event-secret-base">
<h2>Event Secret Base<a class="headerlink" href="#event-secret-base" title="Permalink to this headline"></a></h2>
<p>This is the event used to mark entrances to secret bases. This event will only be functional on certain metatiles. Unfortunately, they are hardcoded into the game’s engine (see <code class="docutils literal notranslate"><span class="pre">sSecretBaseEntranceMetatiles</span></code> in <code class="docutils literal notranslate"><span class="pre">src/secret_base.c</span></code>).</p>
<div class="figure" id="id10">
<div class="figure" id="id11">
<img alt="Event Secret Base Properties" src="../_images/event-secret-base.png" />
<p class="caption"><span class="caption-text">Event Secret Base Properties</span></p>
</div>

10
docs/manual/editing-map-header.html
View file

@ -36,7 +36,7 @@
<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="Changelog" href="../reference/changelog.html" />
<link rel="next" title="Editing Map Connections" href="editing-map-connections.html" />
<link rel="prev" title="Editing Map Events" href="editing-map-events.html" />
</head>
@ -128,6 +128,12 @@
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">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>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
@ -268,7 +274,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../reference/changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="editing-map-connections.html" class="btn btn-neutral float-right" title="Editing Map Connections" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="editing-map-events.html" class="btn btn-neutral float-left" title="Editing Map Events" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

6
docs/manual/editing-map-tiles.html
View file

@ -128,6 +128,12 @@
</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>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>

6
docs/manual/introduction.html
View file

@ -128,6 +128,12 @@
</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>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>

6
docs/manual/navigation.html
View file

@ -128,6 +128,12 @@
</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>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>

BIN
docs/objects.inv
View file

Binary file not shown.

10
docs/reference/changelog.html
View file

@ -37,7 +37,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Related Projects" href="related-projects.html" />
<link rel="prev" title="Editing Map Headers" href="../manual/editing-map-header.html" />
<link rel="prev" title="Editing Map Connections" href="../manual/editing-map-connections.html" />
</head>
<body class="wy-body-for-nav">
@ -128,6 +128,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-header.html">Editing Map Headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-connections.html">Editing Map Connections</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-connections.html#follow-connections">Follow Connections</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul class="current">
@ -378,7 +384,7 @@ and this project somewhat adheres to <a class="reference external" href="https:/
<a href="related-projects.html" class="btn btn-neutral float-right" title="Related Projects" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../manual/editing-map-header.html" class="btn btn-neutral float-left" title="Editing Map Headers" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="../manual/editing-map-connections.html" class="btn btn-neutral float-left" title="Editing Map Connections" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>

6
docs/reference/related-projects.html
View file

@ -127,6 +127,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-header.html">Editing Map Headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-connections.html">Editing Map Connections</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-connections.html#follow-connections">Follow Connections</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul class="current">

6
docs/search.html
View file

@ -127,6 +127,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-connections.html">Editing Map Connections</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#follow-connections">Follow Connections</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>

2
docs/searchindex.js
View file

File diff suppressed because one or more lines are too long

1
docsrc/index.rst
View file

@ -14,6 +14,7 @@ Porymap Documentation
manual/editing-map-collisions
manual/editing-map-events
manual/editing-map-header
manual/editing-map-connections
.. toctree::
:maxdepth: 2

36
docsrc/manual/editing-map-connections.rst Normal file
View file

@ -0,0 +1,36 @@
***********************
Editing Map Connections
***********************
Maps can be connected together so that the player can seamlessly walk between them. These connections can be edited in the Connections tab.
.. figure:: images/editing-map-connections/map-connections.png
:alt: Map Connections View
Map Connections View
A connection has a direction, offset, and destination map. To add new connection, press the plus button |add-connection-button|. To delete a connection, select it and press the delete button |remove-connection-button|.
.. |add-connection-button|
image:: images/editing-map-connections/add-connection-button.png
.. |remove-connection-button|
image:: images/editing-map-connections/remove-connection-button.png
To change the connection's vertical or horizontal offset, it's easiest to click and drag the connection to the desired offset.
Dive & Emerge Warps
-------------------
Dive & emerge warps are used for the HM move Dive. They don't have offsets or directions--only a destination map. To add a dive or emerge warp, simply add a value in the Dive Map and/or Emerge Map dropdown menus.
Mirror Connections
------------------
An extremely useful feature is the *Mirror to Connecting Maps* checkbox in the top-right corner. Connections are one-way, which means that you must keep the two connections in sync between the two maps. For example, Petalburg City has a west connection to Route 104, and Route 104 has an east connection to Petalburg City. If *Mirror to Connecting Maps* is enabled, then Porymap will automatically update both sides of the connection. Be sure to *File -> Save All* (``Ctrl+Shift+S``) when saving, since you will need to save both maps' connections.
Follow Connections
------------------
Double-clicking on a connection will open the destination map. This is very useful for navigating through your maps, similar to double-clicking on :ref:`Event Warps <event-warps>`.

2
docsrc/manual/editing-map-events.rst
View file

@ -70,6 +70,8 @@ Trainer Type
Sight Radius or Berry Tree ID
If the object is a trainer, this property control how many tiles the trainer can see to spot the player for battle. If the object is a berry tree, this specifies the global id of the berry tree. Each berry tree in the game has a unique berry tree id.
.. _event-warps:
Event Warps
-----------

BIN
docsrc/manual/images/editing-map-connections/add-connection-button.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 890 B

BIN
docsrc/manual/images/editing-map-connections/map-connections.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 114 KiB

BIN
docsrc/manual/images/editing-map-connections/remove-connection-button.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 916 B