Add map connections editing docs

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

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

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>`.

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
-----------

Binary file not shown.

After

Width:  |  Height:  |  Size: 890 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 916 B