add 'create new map' docs
This commit is contained in:
garakmon
parent
9330e3bfcf
commit
b8c2fa41ee
59 changed files with 814 additions and 11415 deletions
|
|
@ -1,4 +1,4 @@
|
||||||
# Sphinx build info version 1
|
# Sphinx build info version 1
|
||||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||||
config: e41613e939dfe6ab7008de864b4e64a8
|
config: 9e8b58068fa2090b104690bfc9c25e35
|
||||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||||
|
|
|
||||||
234
docs/README.html
234
docs/README.html
|
|
@ -1,234 +0,0 @@
|
||||||
|
|
||||||
|
|
||||||
<!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>Setup — 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" />
|
|
||||||
</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>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="manual/introduction.html">Introduction</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/introduction.html#about-porymap">About Porymap</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/introduction.html#getting-started">Getting Started</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="manual/navigation.html">Navigation</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#map-list">Map List</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#main-window">Main Window</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#tileset-editor">Tileset Editor</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#region-map-editor">Region Map Editor</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-tiles.html">Editing Map Tiles</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#visual-options">Visual Options</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#selecting-metatiles">Selecting Metatiles</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#pencil-tool">Pencil Tool</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#pointer-tool">Pointer Tool</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#bucket-fill-tool">Bucket Fill Tool</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#map-shift-tool">Map Shift Tool</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#smart-paths">Smart Paths</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#change-map-border">Change Map Border</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#undo-redo">Undo & Redo</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a></li>
|
|
||||||
</ul>
|
|
||||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
|
||||||
<ul>
|
|
||||||
<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> »</li>
|
|
||||||
|
|
||||||
<li>Setup</li>
|
|
||||||
|
|
||||||
|
|
||||||
<li class="wy-breadcrumbs-aside">
|
|
||||||
|
|
||||||
|
|
||||||
<a href="_sources/README.md.txt" rel="nofollow"> View page source</a>
|
|
||||||
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
<hr/>
|
|
||||||
</div>
|
|
||||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
||||||
<div itemprop="articleBody">
|
|
||||||
|
|
||||||
<p>This directory holds the sources that build the porymap documentation website. It uses Sphinx to build a static website, and copy the results to the <code class="docutils literal notranslate"><span class="pre">docs/</span></code> directory for GitHub Pages.</p>
|
|
||||||
<div class="section" id="setup">
|
|
||||||
<h1>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h1>
|
|
||||||
<p>Sphinx uses Python, so you can use <code class="docutils literal notranslate"><span class="pre">pip</span></code> to install the dependencies:</p>
|
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">r</span> <span class="n">requirements</span><span class="o">.</span><span class="n">txt</span>
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="build">
|
|
||||||
<h1>Build<a class="headerlink" href="#build" title="Permalink to this headline">¶</a></h1>
|
|
||||||
<p>This will build the static site and copy the files to the root-level <code class="docutils literal notranslate"><span class="pre">docs/</span></code> directory. The GitHub Pages site will automatically update when the commit is merged to porymap’s <code class="docutils literal notranslate"><span class="pre">master</span></code> branch.</p>
|
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">github</span>
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<footer>
|
|
||||||
|
|
||||||
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<div role="contentinfo">
|
|
||||||
<p>
|
|
||||||
© 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>
|
|
||||||
BIN
docs/_images/event-heal-location.png
Normal file
BIN
docs/_images/event-heal-location.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 64 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 94 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 129 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 87 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 83 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 118 KiB After Width: | Height: | Size: 319 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 170 KiB |
BIN
docs/_images/new-map-options-window.png
Normal file
BIN
docs/_images/new-map-options-window.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 400 KiB |
BIN
docs/_images/right-click-layout-sort.png
Normal file
BIN
docs/_images/right-click-layout-sort.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 109 KiB |
|
|
@ -1,13 +0,0 @@
|
||||||
This directory holds the sources that build the porymap documentation website. It uses Sphinx to build a static website, and copy the results to the `docs/` directory for GitHub Pages.
|
|
||||||
|
|
||||||
## Setup
|
|
||||||
Sphinx uses Python, so you can use `pip` to install the dependencies:
|
|
||||||
```
|
|
||||||
pip install -r requirements.txt
|
|
||||||
```
|
|
||||||
|
|
||||||
## Build
|
|
||||||
This will build the static site and copy the files to the root-level `docs/` directory. The GitHub Pages site will automatically update when the commit is merged to porymap's `master` branch.
|
|
||||||
```
|
|
||||||
make github
|
|
||||||
```
|
|
||||||
|
|
@ -16,6 +16,7 @@ Porymap Documentation
|
||||||
manual/editing-map-header
|
manual/editing-map-header
|
||||||
manual/editing-map-connections
|
manual/editing-map-connections
|
||||||
manual/editing-wild-encounters
|
manual/editing-wild-encounters
|
||||||
|
manual/creating-new-maps
|
||||||
manual/region-map-editor
|
manual/region-map-editor
|
||||||
manual/scripting-capabilities
|
manual/scripting-capabilities
|
||||||
manual/project-files
|
manual/project-files
|
||||||
|
|
|
||||||
73
docs/_sources/manual/creating-new-maps.rst.txt
Normal file
73
docs/_sources/manual/creating-new-maps.rst.txt
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
.. _creating-new-maps:
|
||||||
|
|
||||||
|
*****************
|
||||||
|
Creating New Maps
|
||||||
|
*****************
|
||||||
|
|
||||||
|
Creating a new map in porymap is easy! Just click *Tools -> New Map...*.
|
||||||
|
Alternatively, in any of the map list sort modes, you can right click on a folder
|
||||||
|
in order to add a new map to the folder.
|
||||||
|
|
||||||
|
For example, when sorting maps by their layout, you can add a new Pokemon Center from the existing layout.
|
||||||
|
|
||||||
|
.. figure:: images/creating-new-maps/right-click-layout-sort.png
|
||||||
|
:alt: Add New Map with Layout
|
||||||
|
|
||||||
|
Add New Map with Layout
|
||||||
|
|
||||||
|
New Map Options
|
||||||
|
---------------
|
||||||
|
|
||||||
|
The popup window when you create a new map will display some options in order to customize your new map.
|
||||||
|
|
||||||
|
.. figure:: images/creating-new-maps/new-map-options-window.png
|
||||||
|
:alt: New Map Options Window
|
||||||
|
|
||||||
|
New Map Options Window
|
||||||
|
|
||||||
|
The options you see may be different depending on your base project, but they are:
|
||||||
|
|
||||||
|
Name
|
||||||
|
The name of the new map. This cannot be changed in porymap.
|
||||||
|
|
||||||
|
Group
|
||||||
|
Which map group the new map will beling to. This cannot be changed in porymap.
|
||||||
|
|
||||||
|
Map Width
|
||||||
|
The width (in metatiles) of the map. This can be changed in porymap.
|
||||||
|
|
||||||
|
Map Height
|
||||||
|
The height (in metatiles) of the map. This can be changed in porymap.
|
||||||
|
|
||||||
|
Border Width
|
||||||
|
The width (in metatiles) of the map border blocks. This can be changed in porymap.
|
||||||
|
|
||||||
|
Border Height
|
||||||
|
The height (in metatiles) of the map border blocks. This can be changed in porymap.
|
||||||
|
|
||||||
|
Primary Tileset
|
||||||
|
The map's primary tileset. This can be changed in porymap.
|
||||||
|
|
||||||
|
Secondary Tileset
|
||||||
|
The map's secondary tileset. This can be changed in porymap.
|
||||||
|
|
||||||
|
Type
|
||||||
|
Whether this map is an indoor or outdoor map. This can be changed in porymap.
|
||||||
|
|
||||||
|
Location
|
||||||
|
The region map section this map exists in. This can be changed in porymap.
|
||||||
|
|
||||||
|
Can Fly To
|
||||||
|
Whether a heal location event will be created with this map. This cannot be changed in porymap.
|
||||||
|
|
||||||
|
Allow Running
|
||||||
|
Whether the player can sprint on this map. This can be changed in porymap.
|
||||||
|
|
||||||
|
Allow Biking
|
||||||
|
Whether the player can use the bike on this map. This can be changed in porymap.
|
||||||
|
|
||||||
|
Allow Escape Rope
|
||||||
|
Whether the user can escape from this map. This can be changed in porymap.
|
||||||
|
|
||||||
|
Floor Number
|
||||||
|
The floor number for this map if it is associated with an elevator. This can be changed in porymap.
|
||||||
|
|
@ -9,7 +9,7 @@ Events are what bring your maps to life. They include NPCs, signposts, warps, s
|
||||||
|
|
||||||
Map Events View
|
Map Events View
|
||||||
|
|
||||||
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 ``Ctrl`` and clicking another event.
|
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, simply 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 ``Ctrl`` and clicking another event.
|
||||||
|
|
||||||
.. figure:: images/editing-map-events/event-id-spinner.png
|
.. figure:: images/editing-map-events/event-id-spinner.png
|
||||||
:alt: Event Id Spinner
|
:alt: Event Id Spinner
|
||||||
|
|
@ -65,11 +65,14 @@ Event Flag
|
||||||
The flag value that controls if the object is visible. If the flag is set (equal to 1), then the object will be invisible. If the Event Flag is set to `0`, then the object will always be visible because `0` means "no flag".
|
The flag value that controls if the object is visible. If the flag is set (equal to 1), then the object will be invisible. If the Event Flag is set to `0`, then the object will always be visible because `0` means "no flag".
|
||||||
|
|
||||||
Trainer Type
|
Trainer Type
|
||||||
`NONE`, `NORMAL`, or `SEE ALL DIRECTIONS`. If the object is a trainer, `NORMAL` means that the trainer will spot the player in the object's line-of-sight.
|
The trainer type used by the object. If the object is a trainer, `TRAINER_TYPE_NORMAL` means that the trainer will spot the player in the object's line-of-sight.
|
||||||
|
|
||||||
Sight Radius or Berry Tree ID
|
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.
|
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.
|
||||||
|
|
||||||
|
In Connection
|
||||||
|
Exclusive to pokefirered. Used to replace objects that are visible in a map's connection with their corresponding object on the connecting map. When checked, these objects will make odd use of other fields; its trainer type value will be the connecting map number, its Sight Radius / Berry Tree Id will be the connecting map group, and its z coordinate will be the object's local id on the connecting map.
|
||||||
|
|
||||||
.. _event-warps:
|
.. _event-warps:
|
||||||
|
|
||||||
Warp Events
|
Warp Events
|
||||||
|
|
@ -116,7 +119,7 @@ Var Value
|
||||||
Weather Trigger Events
|
Weather Trigger Events
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
Weather trigger events 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.
|
Weather trigger events 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. This event type is unavailable for pokefirered projects; the functions to trigger weather changes were dummied out.
|
||||||
|
|
||||||
.. figure:: images/editing-map-events/event-weather-trigger.png
|
.. figure:: images/editing-map-events/event-weather-trigger.png
|
||||||
:alt: Weather Trigger Event Properties
|
:alt: Weather Trigger Event Properties
|
||||||
|
|
@ -167,10 +170,17 @@ Item
|
||||||
Flag
|
Flag
|
||||||
This flag is set when the player receives the hidden item.
|
This flag is set when the player receives the hidden item.
|
||||||
|
|
||||||
|
Quantity
|
||||||
|
Exclusive to pokefirered. The number of items received when the item is picked up.
|
||||||
|
|
||||||
|
Requires Itemfinder
|
||||||
|
Exclusive to pokefirered. When checked, the hidden item can only be received by standing on it and using the Itemfinder.
|
||||||
|
|
||||||
Secret Base Event
|
Secret Base Event
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
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 ``sSecretBaseEntranceMetatiles`` in ``src/secret_base.c``).
|
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 ``sSecretBaseEntranceMetatiles`` in ``src/secret_base.c``).
|
||||||
|
This event type is unavailable for pokefirered projects; secret bases do not exist there.
|
||||||
|
|
||||||
.. figure:: images/editing-map-events/event-secret-base.png
|
.. figure:: images/editing-map-events/event-secret-base.png
|
||||||
:alt: Secret Base Event Properties
|
:alt: Secret Base Event Properties
|
||||||
|
|
@ -183,6 +193,22 @@ Id
|
||||||
Secret Base Id
|
Secret Base Id
|
||||||
The id of the destination secret base.
|
The id of the destination secret base.
|
||||||
|
|
||||||
|
Heal Location / Healspots
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
This event is used to control where a player will arrive when they white out or fly to the map. The white out functions a little differently between game versions. For pokeemerald and pokeruby players will arrive at the event's coordinates after a white out, while in pokefirered they will arrive on the map set in ``Respawn Map`` and at hardcoded coordinates (see ``SetWhiteoutRespawnWarpAndHealerNpc`` in ``src/heal_location.c``).
|
||||||
|
|
||||||
|
.. figure:: images/editing-map-events/event-heal-location.png
|
||||||
|
:alt: Heal Location Properties
|
||||||
|
|
||||||
|
Heal Location Properties
|
||||||
|
|
||||||
|
Respawn Map
|
||||||
|
Exclusive to pokefirered. The map where the player will arrive when they white out (e.g. inside the PokéCenter that the heal location is in front of).
|
||||||
|
|
||||||
|
Respawn NPC
|
||||||
|
Exclusive to pokefirered. The local id of the NPC the player will interact with when they white out.
|
||||||
|
|
||||||
Adding & Deleting Events
|
Adding & Deleting Events
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -22,7 +22,7 @@ Weather
|
||||||
The weather that is running when entering the map.
|
The weather that is running when entering the map.
|
||||||
|
|
||||||
Type
|
Type
|
||||||
The type of map. This value is used by various things in the game engine. For example, in Ruby Version, running shoes can only be used when the map type is ``MAP_TYPE_INDOOR``.
|
The type of map. This value is used by various things in the game engine. For example, in Ruby Version, running shoes cannot be used when the map type is ``MAP_TYPE_INDOOR``.
|
||||||
|
|
||||||
Battle Scene
|
Battle Scene
|
||||||
Controls what graphics are used in battles.
|
Controls what graphics are used in battles.
|
||||||
|
|
@ -36,8 +36,11 @@ Allow Running
|
||||||
Allow Biking
|
Allow Biking
|
||||||
Controls whether or not a bike can be used.
|
Controls whether or not a bike can be used.
|
||||||
|
|
||||||
Allow Dig & Escape Rop
|
Allow Dig & Escape Rope
|
||||||
Controls whether the Dig field move or the Escape Rope item can be used.
|
Controls whether the Dig field move or the Escape Rope item can be used.
|
||||||
|
|
||||||
|
Floor Number
|
||||||
|
Exclusive to pokefirered. Used to append a number to the map name popup. Negative values are prefixed with "B" for basement, and floor 127 is "Rooftop".
|
||||||
|
|
||||||
Custom Fields
|
Custom Fields
|
||||||
You can enter custom fields if you need support for additional fields in your project. They can also be useful for keeping notes.
|
You can enter custom fields if you need support for additional fields in your project. They can also be useful for keeping notes.
|
||||||
|
|
|
||||||
|
|
@ -144,6 +144,8 @@ The map's border can be modified by painting on the Border image, which is locat
|
||||||
|
|
||||||
Change Map Border
|
Change Map Border
|
||||||
|
|
||||||
|
The dimensions of the map's border can also be adjusted for pokefirered projects via the ``Change Dimensions`` button. If you have modified your pokeemerald or pokeruby project to support custom border sizes you can enable this option with the ``use_custom_border_size`` field in your project's ``porymap.project.cfg`` file.
|
||||||
|
|
||||||
Change Map Tilesets
|
Change Map Tilesets
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ Porymap reads and writes files in the decompilation projects. It **does not** r
|
||||||
Getting Started
|
Getting Started
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
Before using Porymap, you must have your decompilation project setup. Porymap currently supports `pokeemerald <https://github.com/pret/pokeemerald>`_ and `pokeruby <https://github.com/pret/pokeruby>`_. See their respective ``INSTALL.md`` files to get setup, and make sure you can successfully compile the ROM.
|
Before using Porymap, you must have your decompilation project setup. Porymap supports the `pokeemerald <https://github.com/pret/pokeemerald>`_, `pokeruby <https://github.com/pret/pokeruby>`_, and `pokefirered <https://github.com/pret/pokefirered>`_ decompilation projects. See their respective ``INSTALL.md`` files to get setup, and make sure you can successfully compile the ROM.
|
||||||
|
|
||||||
When launching Porymap for the first time, you will be greeted with the following empty window:
|
When launching Porymap for the first time, you will be greeted with the following empty window:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -25,6 +25,8 @@ Sort by Area
|
||||||
Sort by Layout
|
Sort by Layout
|
||||||
Organizes by map layouts. Most layouts are only used by a single map, but layouts like the Pokemon Center are used by many maps.
|
Organizes by map layouts. Most layouts are only used by a single map, but layouts like the Pokemon Center are used by many maps.
|
||||||
|
|
||||||
|
Right-clicking on the folder name in any of the sort modes will bring up a dialog to create a new map in that folder. For more details, see: :ref:`Creating New Maps <creating-new-maps>`.
|
||||||
|
|
||||||
The *Expand All* |expand-all-button| and *Collapse All* |collapse-all-button| buttons will expand or collapse all of the map folders.
|
The *Expand All* |expand-all-button| and *Collapse All* |collapse-all-button| buttons will expand or collapse all of the map folders.
|
||||||
|
|
||||||
Type in the filter to show maps that contain the filter text.
|
Type in the filter to show maps that contain the filter text.
|
||||||
|
|
@ -81,7 +83,7 @@ The Tileset Editor can be opened with *File -> Tileset Editor*. When the Tilese
|
||||||
Region Map Editor
|
Region Map Editor
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
The Region Map Editor can be opened with *File -> Region Map Editor*. This window will allow you to modify the look and layout of maps on the game's region map. You can also modify the city map images using the bottom two panes.
|
The Region Map Editor can be opened with *File -> Region Map Editor*. This window will allow you to modify the look and layout of maps on the game's region map. You can also modify the city map images using the bottom two panes. Currently the Region Map Editor is only available for pokeemerald and pokeruby projects.
|
||||||
|
|
||||||
.. figure:: images/navigation/region-map-editor.png
|
.. figure:: images/navigation/region-map-editor.png
|
||||||
:alt: Region Map Editor
|
:alt: Region Map Editor
|
||||||
|
|
|
||||||
|
|
@ -19,10 +19,10 @@ to a file, it probably is not a good idea to edit yourself unless otherwise note
|
||||||
data/tilesets/graphics.inc, yes, yes, also edits palette and tile image files listed in this file
|
data/tilesets/graphics.inc, yes, yes, also edits palette and tile image files listed in this file
|
||||||
data/tilesets/metatiles.inc, yes, yes, also edits metatile files listed in this file
|
data/tilesets/metatiles.inc, yes, yes, also edits metatile files listed in this file
|
||||||
src/data/wild_encounters.json, yes, yes,
|
src/data/wild_encounters.json, yes, yes,
|
||||||
src/data/field_event_obj/event_object_graphics_info_pointers.h, yes, no,
|
src/data/object_events/object_event_graphics_info_pointers.h, yes, no,
|
||||||
src/data/field_event_obj/event_object_graphics_info.h, yes, no,
|
src/data/object_events/object_event_graphics_info.h, yes, no,
|
||||||
src/data/field_event_obj/event_object_pic_tables.h, yes, no,
|
src/data/object_events/object_event_pic_tables.h, yes, no,
|
||||||
src/data/field_event_obj/event_object_graphics.h, yes, no,
|
src/data/object_events/object_event_graphics.h, yes, no,
|
||||||
src/data/graphics/pokemon.h, yes, no, for pokemon sprite icons
|
src/data/graphics/pokemon.h, yes, no, for pokemon sprite icons
|
||||||
src/data/heal_locations.h, yes, yes,
|
src/data/heal_locations.h, yes, yes,
|
||||||
src/data/region_map/region_map_entries.h, yes, yes,
|
src/data/region_map/region_map_entries.h, yes, yes,
|
||||||
|
|
@ -34,13 +34,13 @@ to a file, it probably is not a good idea to edit yourself unless otherwise note
|
||||||
include/constants/heal_locations.h, no, yes,
|
include/constants/heal_locations.h, no, yes,
|
||||||
include/constants/pokemon.h, yes, no, reads min and max level constants
|
include/constants/pokemon.h, yes, no, reads min and max level constants
|
||||||
include/constants/map_types.h, yes, no,
|
include/constants/map_types.h, yes, no,
|
||||||
include/constants/secret_bases.h, yes, no,
|
include/constants/trainer_types.h, yes, no,
|
||||||
include/constants/event_object_movement_constants.h, yes, no,
|
include/constants/secret_bases.h, yes, no, pokeemerald and pokeruby only
|
||||||
include/constants/bg_event_constants.h, yes, no,
|
include/constants/event_object_movement.h, yes, no,
|
||||||
|
include/constants/event_bg.h, yes, no,
|
||||||
include/constants/region_map_sections.h, yes, no,
|
include/constants/region_map_sections.h, yes, no,
|
||||||
include/constants/metatile_labels.h, yes, yes,
|
include/constants/metatile_labels.h, yes, yes,
|
||||||
include/constants/metatile_behaviors.h, yes, no,
|
include/constants/metatile_behaviors.h, yes, no,
|
||||||
include/constants/bg_event_constants.h, yes, no,
|
|
||||||
include/fieldmap.h, yes, no, reads tileset related constants
|
include/fieldmap.h, yes, no, reads tileset related constants
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,6 +5,9 @@ The Region Map Editor
|
||||||
This is where you edit the region map for your game. To open the region map
|
This is where you edit the region map for your game. To open the region map
|
||||||
editor, navigate to *Tools -> Region Map Editor* from porymap's main window.
|
editor, navigate to *Tools -> Region Map Editor* from porymap's main window.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
The region map editor is currently only available for pokeemerald and pokeruby.
|
||||||
|
|
||||||
When you first open the region map editor, your window will look like this:
|
When you first open the region map editor, your window will look like this:
|
||||||
|
|
||||||
.. figure:: images/region-map-editor/rme-new-window.png
|
.. figure:: images/region-map-editor/rme-new-window.png
|
||||||
|
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
***********
|
|
||||||
Changelog
|
|
||||||
***********
|
|
||||||
BIN
docs/_static/ajax-loader.gif
vendored
BIN
docs/_static/ajax-loader.gif
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 673 B |
BIN
docs/_static/comment-bright.png
vendored
BIN
docs/_static/comment-bright.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 756 B |
BIN
docs/_static/comment-close.png
vendored
BIN
docs/_static/comment-close.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 829 B |
BIN
docs/_static/comment.png
vendored
BIN
docs/_static/comment.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 641 B |
1
docs/_static/documentation_options.js
vendored
1
docs/_static/documentation_options.js
vendored
|
|
@ -5,6 +5,7 @@ var DOCUMENTATION_OPTIONS = {
|
||||||
COLLAPSE_INDEX: false,
|
COLLAPSE_INDEX: false,
|
||||||
BUILDER: 'html',
|
BUILDER: 'html',
|
||||||
FILE_SUFFIX: '.html',
|
FILE_SUFFIX: '.html',
|
||||||
|
LINK_SUFFIX: '.html',
|
||||||
HAS_SOURCE: true,
|
HAS_SOURCE: true,
|
||||||
SOURCELINK_SUFFIX: '.txt',
|
SOURCELINK_SUFFIX: '.txt',
|
||||||
NAVIGATION_WITH_KEYS: false
|
NAVIGATION_WITH_KEYS: false
|
||||||
|
|
|
||||||
BIN
docs/_static/down-pressed.png
vendored
BIN
docs/_static/down-pressed.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 222 B |
BIN
docs/_static/down.png
vendored
BIN
docs/_static/down.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 202 B |
10253
docs/_static/jquery-3.2.1.js
vendored
10253
docs/_static/jquery-3.2.1.js
vendored
File diff suppressed because it is too large
Load diff
5
docs/_static/searchtools.js
vendored
5
docs/_static/searchtools.js
vendored
|
|
@ -251,6 +251,7 @@ var Search = {
|
||||||
var item = results.pop();
|
var item = results.pop();
|
||||||
var listItem = $('<li style="display:none"></li>');
|
var listItem = $('<li style="display:none"></li>');
|
||||||
var requestUrl = "";
|
var requestUrl = "";
|
||||||
|
var linkUrl = "";
|
||||||
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
|
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
|
||||||
// dirhtml builder
|
// dirhtml builder
|
||||||
var dirname = item[0] + '/';
|
var dirname = item[0] + '/';
|
||||||
|
|
@ -260,13 +261,15 @@ var Search = {
|
||||||
dirname = '';
|
dirname = '';
|
||||||
}
|
}
|
||||||
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
|
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
|
||||||
|
linkUrl = requestUrl;
|
||||||
|
|
||||||
} else {
|
} else {
|
||||||
// normal html builders
|
// normal html builders
|
||||||
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
|
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
|
||||||
|
linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
|
||||||
}
|
}
|
||||||
listItem.append($('<a/>').attr('href',
|
listItem.append($('<a/>').attr('href',
|
||||||
requestUrl +
|
linkUrl +
|
||||||
highlightstring + item[2]).html(item[1]));
|
highlightstring + item[2]).html(item[1]));
|
||||||
if (item[3]) {
|
if (item[3]) {
|
||||||
listItem.append($('<span> (' + item[3] + ')</span>'));
|
listItem.append($('<span> (' + item[3] + ')</span>'));
|
||||||
|
|
|
||||||
BIN
docs/_static/up-pressed.png
vendored
BIN
docs/_static/up-pressed.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 214 B |
BIN
docs/_static/up.png
vendored
BIN
docs/_static/up.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 203 B |
808
docs/_static/websupport.js
vendored
808
docs/_static/websupport.js
vendored
|
|
@ -1,808 +0,0 @@
|
||||||
/*
|
|
||||||
* websupport.js
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
*
|
|
||||||
* sphinx.websupport utilities for all documentation.
|
|
||||||
*
|
|
||||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
|
||||||
* :license: BSD, see LICENSE for details.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
(function($) {
|
|
||||||
$.fn.autogrow = function() {
|
|
||||||
return this.each(function() {
|
|
||||||
var textarea = this;
|
|
||||||
|
|
||||||
$.fn.autogrow.resize(textarea);
|
|
||||||
|
|
||||||
$(textarea)
|
|
||||||
.focus(function() {
|
|
||||||
textarea.interval = setInterval(function() {
|
|
||||||
$.fn.autogrow.resize(textarea);
|
|
||||||
}, 500);
|
|
||||||
})
|
|
||||||
.blur(function() {
|
|
||||||
clearInterval(textarea.interval);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
$.fn.autogrow.resize = function(textarea) {
|
|
||||||
var lineHeight = parseInt($(textarea).css('line-height'), 10);
|
|
||||||
var lines = textarea.value.split('\n');
|
|
||||||
var columns = textarea.cols;
|
|
||||||
var lineCount = 0;
|
|
||||||
$.each(lines, function() {
|
|
||||||
lineCount += Math.ceil(this.length / columns) || 1;
|
|
||||||
});
|
|
||||||
var height = lineHeight * (lineCount + 1);
|
|
||||||
$(textarea).css('height', height);
|
|
||||||
};
|
|
||||||
})(jQuery);
|
|
||||||
|
|
||||||
(function($) {
|
|
||||||
var comp, by;
|
|
||||||
|
|
||||||
function init() {
|
|
||||||
initEvents();
|
|
||||||
initComparator();
|
|
||||||
}
|
|
||||||
|
|
||||||
function initEvents() {
|
|
||||||
$(document).on("click", 'a.comment-close', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
hide($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.vote', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
handleVote($(this));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.reply', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
openReply($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.close-reply', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
closeReply($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.sort-option', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
handleReSort($(this));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.show-proposal', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
showProposal($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.hide-proposal', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
hideProposal($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.show-propose-change', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
showProposeChange($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.hide-propose-change', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
hideProposeChange($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.accept-comment', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
acceptComment($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.delete-comment', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
deleteComment($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.comment-markup', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
toggleCommentMarkupBox($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set comp, which is a comparator function used for sorting and
|
|
||||||
* inserting comments into the list.
|
|
||||||
*/
|
|
||||||
function setComparator() {
|
|
||||||
// If the first three letters are "asc", sort in ascending order
|
|
||||||
// and remove the prefix.
|
|
||||||
if (by.substring(0,3) == 'asc') {
|
|
||||||
var i = by.substring(3);
|
|
||||||
comp = function(a, b) { return a[i] - b[i]; };
|
|
||||||
} else {
|
|
||||||
// Otherwise sort in descending order.
|
|
||||||
comp = function(a, b) { return b[by] - a[by]; };
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reset link styles and format the selected sort option.
|
|
||||||
$('a.sel').attr('href', '#').removeClass('sel');
|
|
||||||
$('a.by' + by).removeAttr('href').addClass('sel');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a comp function. If the user has preferences stored in
|
|
||||||
* the sortBy cookie, use those, otherwise use the default.
|
|
||||||
*/
|
|
||||||
function initComparator() {
|
|
||||||
by = 'rating'; // Default to sort by rating.
|
|
||||||
// If the sortBy cookie is set, use that instead.
|
|
||||||
if (document.cookie.length > 0) {
|
|
||||||
var start = document.cookie.indexOf('sortBy=');
|
|
||||||
if (start != -1) {
|
|
||||||
start = start + 7;
|
|
||||||
var end = document.cookie.indexOf(";", start);
|
|
||||||
if (end == -1) {
|
|
||||||
end = document.cookie.length;
|
|
||||||
by = unescape(document.cookie.substring(start, end));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
setComparator();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Show a comment div.
|
|
||||||
*/
|
|
||||||
function show(id) {
|
|
||||||
$('#ao' + id).hide();
|
|
||||||
$('#ah' + id).show();
|
|
||||||
var context = $.extend({id: id}, opts);
|
|
||||||
var popup = $(renderTemplate(popupTemplate, context)).hide();
|
|
||||||
popup.find('textarea[name="proposal"]').hide();
|
|
||||||
popup.find('a.by' + by).addClass('sel');
|
|
||||||
var form = popup.find('#cf' + id);
|
|
||||||
form.submit(function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
addComment(form);
|
|
||||||
});
|
|
||||||
$('#s' + id).after(popup);
|
|
||||||
popup.slideDown('fast', function() {
|
|
||||||
getComments(id);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Hide a comment div.
|
|
||||||
*/
|
|
||||||
function hide(id) {
|
|
||||||
$('#ah' + id).hide();
|
|
||||||
$('#ao' + id).show();
|
|
||||||
var div = $('#sc' + id);
|
|
||||||
div.slideUp('fast', function() {
|
|
||||||
div.remove();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Perform an ajax request to get comments for a node
|
|
||||||
* and insert the comments into the comments tree.
|
|
||||||
*/
|
|
||||||
function getComments(id) {
|
|
||||||
$.ajax({
|
|
||||||
type: 'GET',
|
|
||||||
url: opts.getCommentsURL,
|
|
||||||
data: {node: id},
|
|
||||||
success: function(data, textStatus, request) {
|
|
||||||
var ul = $('#cl' + id);
|
|
||||||
var speed = 100;
|
|
||||||
$('#cf' + id)
|
|
||||||
.find('textarea[name="proposal"]')
|
|
||||||
.data('source', data.source);
|
|
||||||
|
|
||||||
if (data.comments.length === 0) {
|
|
||||||
ul.html('<li>No comments yet.</li>');
|
|
||||||
ul.data('empty', true);
|
|
||||||
} else {
|
|
||||||
// If there are comments, sort them and put them in the list.
|
|
||||||
var comments = sortComments(data.comments);
|
|
||||||
speed = data.comments.length * 100;
|
|
||||||
appendComments(comments, ul);
|
|
||||||
ul.data('empty', false);
|
|
||||||
}
|
|
||||||
$('#cn' + id).slideUp(speed + 200);
|
|
||||||
ul.slideDown(speed);
|
|
||||||
},
|
|
||||||
error: function(request, textStatus, error) {
|
|
||||||
showError('Oops, there was a problem retrieving the comments.');
|
|
||||||
},
|
|
||||||
dataType: 'json'
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add a comment via ajax and insert the comment into the comment tree.
|
|
||||||
*/
|
|
||||||
function addComment(form) {
|
|
||||||
var node_id = form.find('input[name="node"]').val();
|
|
||||||
var parent_id = form.find('input[name="parent"]').val();
|
|
||||||
var text = form.find('textarea[name="comment"]').val();
|
|
||||||
var proposal = form.find('textarea[name="proposal"]').val();
|
|
||||||
|
|
||||||
if (text == '') {
|
|
||||||
showError('Please enter a comment.');
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Disable the form that is being submitted.
|
|
||||||
form.find('textarea,input').attr('disabled', 'disabled');
|
|
||||||
|
|
||||||
// Send the comment to the server.
|
|
||||||
$.ajax({
|
|
||||||
type: "POST",
|
|
||||||
url: opts.addCommentURL,
|
|
||||||
dataType: 'json',
|
|
||||||
data: {
|
|
||||||
node: node_id,
|
|
||||||
parent: parent_id,
|
|
||||||
text: text,
|
|
||||||
proposal: proposal
|
|
||||||
},
|
|
||||||
success: function(data, textStatus, error) {
|
|
||||||
// Reset the form.
|
|
||||||
if (node_id) {
|
|
||||||
hideProposeChange(node_id);
|
|
||||||
}
|
|
||||||
form.find('textarea')
|
|
||||||
.val('')
|
|
||||||
.add(form.find('input'))
|
|
||||||
.removeAttr('disabled');
|
|
||||||
var ul = $('#cl' + (node_id || parent_id));
|
|
||||||
if (ul.data('empty')) {
|
|
||||||
$(ul).empty();
|
|
||||||
ul.data('empty', false);
|
|
||||||
}
|
|
||||||
insertComment(data.comment);
|
|
||||||
var ao = $('#ao' + node_id);
|
|
||||||
ao.find('img').attr({'src': opts.commentBrightImage});
|
|
||||||
if (node_id) {
|
|
||||||
// if this was a "root" comment, remove the commenting box
|
|
||||||
// (the user can get it back by reopening the comment popup)
|
|
||||||
$('#ca' + node_id).slideUp();
|
|
||||||
}
|
|
||||||
},
|
|
||||||
error: function(request, textStatus, error) {
|
|
||||||
form.find('textarea,input').removeAttr('disabled');
|
|
||||||
showError('Oops, there was a problem adding the comment.');
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Recursively append comments to the main comment list and children
|
|
||||||
* lists, creating the comment tree.
|
|
||||||
*/
|
|
||||||
function appendComments(comments, ul) {
|
|
||||||
$.each(comments, function() {
|
|
||||||
var div = createCommentDiv(this);
|
|
||||||
ul.append($(document.createElement('li')).html(div));
|
|
||||||
appendComments(this.children, div.find('ul.comment-children'));
|
|
||||||
// To avoid stagnating data, don't store the comments children in data.
|
|
||||||
this.children = null;
|
|
||||||
div.data('comment', this);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* After adding a new comment, it must be inserted in the correct
|
|
||||||
* location in the comment tree.
|
|
||||||
*/
|
|
||||||
function insertComment(comment) {
|
|
||||||
var div = createCommentDiv(comment);
|
|
||||||
|
|
||||||
// To avoid stagnating data, don't store the comments children in data.
|
|
||||||
comment.children = null;
|
|
||||||
div.data('comment', comment);
|
|
||||||
|
|
||||||
var ul = $('#cl' + (comment.node || comment.parent));
|
|
||||||
var siblings = getChildren(ul);
|
|
||||||
|
|
||||||
var li = $(document.createElement('li'));
|
|
||||||
li.hide();
|
|
||||||
|
|
||||||
// Determine where in the parents children list to insert this comment.
|
|
||||||
for(var i=0; i < siblings.length; i++) {
|
|
||||||
if (comp(comment, siblings[i]) <= 0) {
|
|
||||||
$('#cd' + siblings[i].id)
|
|
||||||
.parent()
|
|
||||||
.before(li.html(div));
|
|
||||||
li.slideDown('fast');
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// If we get here, this comment rates lower than all the others,
|
|
||||||
// or it is the only comment in the list.
|
|
||||||
ul.append(li.html(div));
|
|
||||||
li.slideDown('fast');
|
|
||||||
}
|
|
||||||
|
|
||||||
function acceptComment(id) {
|
|
||||||
$.ajax({
|
|
||||||
type: 'POST',
|
|
||||||
url: opts.acceptCommentURL,
|
|
||||||
data: {id: id},
|
|
||||||
success: function(data, textStatus, request) {
|
|
||||||
$('#cm' + id).fadeOut('fast');
|
|
||||||
$('#cd' + id).removeClass('moderate');
|
|
||||||
},
|
|
||||||
error: function(request, textStatus, error) {
|
|
||||||
showError('Oops, there was a problem accepting the comment.');
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function deleteComment(id) {
|
|
||||||
$.ajax({
|
|
||||||
type: 'POST',
|
|
||||||
url: opts.deleteCommentURL,
|
|
||||||
data: {id: id},
|
|
||||||
success: function(data, textStatus, request) {
|
|
||||||
var div = $('#cd' + id);
|
|
||||||
if (data == 'delete') {
|
|
||||||
// Moderator mode: remove the comment and all children immediately
|
|
||||||
div.slideUp('fast', function() {
|
|
||||||
div.remove();
|
|
||||||
});
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// User mode: only mark the comment as deleted
|
|
||||||
div
|
|
||||||
.find('span.user-id:first')
|
|
||||||
.text('[deleted]').end()
|
|
||||||
.find('div.comment-text:first')
|
|
||||||
.text('[deleted]').end()
|
|
||||||
.find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
|
|
||||||
', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
|
|
||||||
.remove();
|
|
||||||
var comment = div.data('comment');
|
|
||||||
comment.username = '[deleted]';
|
|
||||||
comment.text = '[deleted]';
|
|
||||||
div.data('comment', comment);
|
|
||||||
},
|
|
||||||
error: function(request, textStatus, error) {
|
|
||||||
showError('Oops, there was a problem deleting the comment.');
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function showProposal(id) {
|
|
||||||
$('#sp' + id).hide();
|
|
||||||
$('#hp' + id).show();
|
|
||||||
$('#pr' + id).slideDown('fast');
|
|
||||||
}
|
|
||||||
|
|
||||||
function hideProposal(id) {
|
|
||||||
$('#hp' + id).hide();
|
|
||||||
$('#sp' + id).show();
|
|
||||||
$('#pr' + id).slideUp('fast');
|
|
||||||
}
|
|
||||||
|
|
||||||
function showProposeChange(id) {
|
|
||||||
$('#pc' + id).hide();
|
|
||||||
$('#hc' + id).show();
|
|
||||||
var textarea = $('#pt' + id);
|
|
||||||
textarea.val(textarea.data('source'));
|
|
||||||
$.fn.autogrow.resize(textarea[0]);
|
|
||||||
textarea.slideDown('fast');
|
|
||||||
}
|
|
||||||
|
|
||||||
function hideProposeChange(id) {
|
|
||||||
$('#hc' + id).hide();
|
|
||||||
$('#pc' + id).show();
|
|
||||||
var textarea = $('#pt' + id);
|
|
||||||
textarea.val('').removeAttr('disabled');
|
|
||||||
textarea.slideUp('fast');
|
|
||||||
}
|
|
||||||
|
|
||||||
function toggleCommentMarkupBox(id) {
|
|
||||||
$('#mb' + id).toggle();
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Handle when the user clicks on a sort by link. */
|
|
||||||
function handleReSort(link) {
|
|
||||||
var classes = link.attr('class').split(/\s+/);
|
|
||||||
for (var i=0; i<classes.length; i++) {
|
|
||||||
if (classes[i] != 'sort-option') {
|
|
||||||
by = classes[i].substring(2);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
setComparator();
|
|
||||||
// Save/update the sortBy cookie.
|
|
||||||
var expiration = new Date();
|
|
||||||
expiration.setDate(expiration.getDate() + 365);
|
|
||||||
document.cookie= 'sortBy=' + escape(by) +
|
|
||||||
';expires=' + expiration.toUTCString();
|
|
||||||
$('ul.comment-ul').each(function(index, ul) {
|
|
||||||
var comments = getChildren($(ul), true);
|
|
||||||
comments = sortComments(comments);
|
|
||||||
appendComments(comments, $(ul).empty());
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Function to process a vote when a user clicks an arrow.
|
|
||||||
*/
|
|
||||||
function handleVote(link) {
|
|
||||||
if (!opts.voting) {
|
|
||||||
showError("You'll need to login to vote.");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
var id = link.attr('id');
|
|
||||||
if (!id) {
|
|
||||||
// Didn't click on one of the voting arrows.
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// If it is an unvote, the new vote value is 0,
|
|
||||||
// Otherwise it's 1 for an upvote, or -1 for a downvote.
|
|
||||||
var value = 0;
|
|
||||||
if (id.charAt(1) != 'u') {
|
|
||||||
value = id.charAt(0) == 'u' ? 1 : -1;
|
|
||||||
}
|
|
||||||
// The data to be sent to the server.
|
|
||||||
var d = {
|
|
||||||
comment_id: id.substring(2),
|
|
||||||
value: value
|
|
||||||
};
|
|
||||||
|
|
||||||
// Swap the vote and unvote links.
|
|
||||||
link.hide();
|
|
||||||
$('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
|
|
||||||
.show();
|
|
||||||
|
|
||||||
// The div the comment is displayed in.
|
|
||||||
var div = $('div#cd' + d.comment_id);
|
|
||||||
var data = div.data('comment');
|
|
||||||
|
|
||||||
// If this is not an unvote, and the other vote arrow has
|
|
||||||
// already been pressed, unpress it.
|
|
||||||
if ((d.value !== 0) && (data.vote === d.value * -1)) {
|
|
||||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
|
|
||||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Update the comments rating in the local data.
|
|
||||||
data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
|
|
||||||
data.vote = d.value;
|
|
||||||
div.data('comment', data);
|
|
||||||
|
|
||||||
// Change the rating text.
|
|
||||||
div.find('.rating:first')
|
|
||||||
.text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));
|
|
||||||
|
|
||||||
// Send the vote information to the server.
|
|
||||||
$.ajax({
|
|
||||||
type: "POST",
|
|
||||||
url: opts.processVoteURL,
|
|
||||||
data: d,
|
|
||||||
error: function(request, textStatus, error) {
|
|
||||||
showError('Oops, there was a problem casting that vote.');
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Open a reply form used to reply to an existing comment.
|
|
||||||
*/
|
|
||||||
function openReply(id) {
|
|
||||||
// Swap out the reply link for the hide link
|
|
||||||
$('#rl' + id).hide();
|
|
||||||
$('#cr' + id).show();
|
|
||||||
|
|
||||||
// Add the reply li to the children ul.
|
|
||||||
var div = $(renderTemplate(replyTemplate, {id: id})).hide();
|
|
||||||
$('#cl' + id)
|
|
||||||
.prepend(div)
|
|
||||||
// Setup the submit handler for the reply form.
|
|
||||||
.find('#rf' + id)
|
|
||||||
.submit(function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
addComment($('#rf' + id));
|
|
||||||
closeReply(id);
|
|
||||||
})
|
|
||||||
.find('input[type=button]')
|
|
||||||
.click(function() {
|
|
||||||
closeReply(id);
|
|
||||||
});
|
|
||||||
div.slideDown('fast', function() {
|
|
||||||
$('#rf' + id).find('textarea').focus();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Close the reply form opened with openReply.
|
|
||||||
*/
|
|
||||||
function closeReply(id) {
|
|
||||||
// Remove the reply div from the DOM.
|
|
||||||
$('#rd' + id).slideUp('fast', function() {
|
|
||||||
$(this).remove();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Swap out the hide link for the reply link
|
|
||||||
$('#cr' + id).hide();
|
|
||||||
$('#rl' + id).show();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Recursively sort a tree of comments using the comp comparator.
|
|
||||||
*/
|
|
||||||
function sortComments(comments) {
|
|
||||||
comments.sort(comp);
|
|
||||||
$.each(comments, function() {
|
|
||||||
this.children = sortComments(this.children);
|
|
||||||
});
|
|
||||||
return comments;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the children comments from a ul. If recursive is true,
|
|
||||||
* recursively include childrens' children.
|
|
||||||
*/
|
|
||||||
function getChildren(ul, recursive) {
|
|
||||||
var children = [];
|
|
||||||
ul.children().children("[id^='cd']")
|
|
||||||
.each(function() {
|
|
||||||
var comment = $(this).data('comment');
|
|
||||||
if (recursive)
|
|
||||||
comment.children = getChildren($(this).find('#cl' + comment.id), true);
|
|
||||||
children.push(comment);
|
|
||||||
});
|
|
||||||
return children;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Create a div to display a comment in. */
|
|
||||||
function createCommentDiv(comment) {
|
|
||||||
if (!comment.displayed && !opts.moderator) {
|
|
||||||
return $('<div class="moderate">Thank you! Your comment will show up '
|
|
||||||
+ 'once it is has been approved by a moderator.</div>');
|
|
||||||
}
|
|
||||||
// Prettify the comment rating.
|
|
||||||
comment.pretty_rating = comment.rating + ' point' +
|
|
||||||
(comment.rating == 1 ? '' : 's');
|
|
||||||
// Make a class (for displaying not yet moderated comments differently)
|
|
||||||
comment.css_class = comment.displayed ? '' : ' moderate';
|
|
||||||
// Create a div for this comment.
|
|
||||||
var context = $.extend({}, opts, comment);
|
|
||||||
var div = $(renderTemplate(commentTemplate, context));
|
|
||||||
|
|
||||||
// If the user has voted on this comment, highlight the correct arrow.
|
|
||||||
if (comment.vote) {
|
|
||||||
var direction = (comment.vote == 1) ? 'u' : 'd';
|
|
||||||
div.find('#' + direction + 'v' + comment.id).hide();
|
|
||||||
div.find('#' + direction + 'u' + comment.id).show();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (opts.moderator || comment.text != '[deleted]') {
|
|
||||||
div.find('a.reply').show();
|
|
||||||
if (comment.proposal_diff)
|
|
||||||
div.find('#sp' + comment.id).show();
|
|
||||||
if (opts.moderator && !comment.displayed)
|
|
||||||
div.find('#cm' + comment.id).show();
|
|
||||||
if (opts.moderator || (opts.username == comment.username))
|
|
||||||
div.find('#dc' + comment.id).show();
|
|
||||||
}
|
|
||||||
return div;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A simple template renderer. Placeholders such as <%id%> are replaced
|
|
||||||
* by context['id'] with items being escaped. Placeholders such as <#id#>
|
|
||||||
* are not escaped.
|
|
||||||
*/
|
|
||||||
function renderTemplate(template, context) {
|
|
||||||
var esc = $(document.createElement('div'));
|
|
||||||
|
|
||||||
function handle(ph, escape) {
|
|
||||||
var cur = context;
|
|
||||||
$.each(ph.split('.'), function() {
|
|
||||||
cur = cur[this];
|
|
||||||
});
|
|
||||||
return escape ? esc.text(cur || "").html() : cur;
|
|
||||||
}
|
|
||||||
|
|
||||||
return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
|
|
||||||
return handle(arguments[2], arguments[1] == '%' ? true : false);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Flash an error message briefly. */
|
|
||||||
function showError(message) {
|
|
||||||
$(document.createElement('div')).attr({'class': 'popup-error'})
|
|
||||||
.append($(document.createElement('div'))
|
|
||||||
.attr({'class': 'error-message'}).text(message))
|
|
||||||
.appendTo('body')
|
|
||||||
.fadeIn("slow")
|
|
||||||
.delay(2000)
|
|
||||||
.fadeOut("slow");
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Add a link the user uses to open the comments popup. */
|
|
||||||
$.fn.comment = function() {
|
|
||||||
return this.each(function() {
|
|
||||||
var id = $(this).attr('id').substring(1);
|
|
||||||
var count = COMMENT_METADATA[id];
|
|
||||||
var title = count + ' comment' + (count == 1 ? '' : 's');
|
|
||||||
var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
|
|
||||||
var addcls = count == 0 ? ' nocomment' : '';
|
|
||||||
$(this)
|
|
||||||
.append(
|
|
||||||
$(document.createElement('a')).attr({
|
|
||||||
href: '#',
|
|
||||||
'class': 'sphinx-comment-open' + addcls,
|
|
||||||
id: 'ao' + id
|
|
||||||
})
|
|
||||||
.append($(document.createElement('img')).attr({
|
|
||||||
src: image,
|
|
||||||
alt: 'comment',
|
|
||||||
title: title
|
|
||||||
}))
|
|
||||||
.click(function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
show($(this).attr('id').substring(2));
|
|
||||||
})
|
|
||||||
)
|
|
||||||
.append(
|
|
||||||
$(document.createElement('a')).attr({
|
|
||||||
href: '#',
|
|
||||||
'class': 'sphinx-comment-close hidden',
|
|
||||||
id: 'ah' + id
|
|
||||||
})
|
|
||||||
.append($(document.createElement('img')).attr({
|
|
||||||
src: opts.closeCommentImage,
|
|
||||||
alt: 'close',
|
|
||||||
title: 'close'
|
|
||||||
}))
|
|
||||||
.click(function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
hide($(this).attr('id').substring(2));
|
|
||||||
})
|
|
||||||
);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
var opts = {
|
|
||||||
processVoteURL: '/_process_vote',
|
|
||||||
addCommentURL: '/_add_comment',
|
|
||||||
getCommentsURL: '/_get_comments',
|
|
||||||
acceptCommentURL: '/_accept_comment',
|
|
||||||
deleteCommentURL: '/_delete_comment',
|
|
||||||
commentImage: '/static/_static/comment.png',
|
|
||||||
closeCommentImage: '/static/_static/comment-close.png',
|
|
||||||
loadingImage: '/static/_static/ajax-loader.gif',
|
|
||||||
commentBrightImage: '/static/_static/comment-bright.png',
|
|
||||||
upArrow: '/static/_static/up.png',
|
|
||||||
downArrow: '/static/_static/down.png',
|
|
||||||
upArrowPressed: '/static/_static/up-pressed.png',
|
|
||||||
downArrowPressed: '/static/_static/down-pressed.png',
|
|
||||||
voting: false,
|
|
||||||
moderator: false
|
|
||||||
};
|
|
||||||
|
|
||||||
if (typeof COMMENT_OPTIONS != "undefined") {
|
|
||||||
opts = jQuery.extend(opts, COMMENT_OPTIONS);
|
|
||||||
}
|
|
||||||
|
|
||||||
var popupTemplate = '\
|
|
||||||
<div class="sphinx-comments" id="sc<%id%>">\
|
|
||||||
<p class="sort-options">\
|
|
||||||
Sort by:\
|
|
||||||
<a href="#" class="sort-option byrating">best rated</a>\
|
|
||||||
<a href="#" class="sort-option byascage">newest</a>\
|
|
||||||
<a href="#" class="sort-option byage">oldest</a>\
|
|
||||||
</p>\
|
|
||||||
<div class="comment-header">Comments</div>\
|
|
||||||
<div class="comment-loading" id="cn<%id%>">\
|
|
||||||
loading comments... <img src="<%loadingImage%>" alt="" /></div>\
|
|
||||||
<ul id="cl<%id%>" class="comment-ul"></ul>\
|
|
||||||
<div id="ca<%id%>">\
|
|
||||||
<p class="add-a-comment">Add a comment\
|
|
||||||
(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
|
|
||||||
<div class="comment-markup-box" id="mb<%id%>">\
|
|
||||||
reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
|
|
||||||
<code>``code``</code>, \
|
|
||||||
code blocks: <code>::</code> and an indented block after blank line</div>\
|
|
||||||
<form method="post" id="cf<%id%>" class="comment-form" action="">\
|
|
||||||
<textarea name="comment" cols="80"></textarea>\
|
|
||||||
<p class="propose-button">\
|
|
||||||
<a href="#" id="pc<%id%>" class="show-propose-change">\
|
|
||||||
Propose a change ▹\
|
|
||||||
</a>\
|
|
||||||
<a href="#" id="hc<%id%>" class="hide-propose-change">\
|
|
||||||
Propose a change ▿\
|
|
||||||
</a>\
|
|
||||||
</p>\
|
|
||||||
<textarea name="proposal" id="pt<%id%>" cols="80"\
|
|
||||||
spellcheck="false"></textarea>\
|
|
||||||
<input type="submit" value="Add comment" />\
|
|
||||||
<input type="hidden" name="node" value="<%id%>" />\
|
|
||||||
<input type="hidden" name="parent" value="" />\
|
|
||||||
</form>\
|
|
||||||
</div>\
|
|
||||||
</div>';
|
|
||||||
|
|
||||||
var commentTemplate = '\
|
|
||||||
<div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
|
|
||||||
<div class="vote">\
|
|
||||||
<div class="arrow">\
|
|
||||||
<a href="#" id="uv<%id%>" class="vote" title="vote up">\
|
|
||||||
<img src="<%upArrow%>" />\
|
|
||||||
</a>\
|
|
||||||
<a href="#" id="uu<%id%>" class="un vote" title="vote up">\
|
|
||||||
<img src="<%upArrowPressed%>" />\
|
|
||||||
</a>\
|
|
||||||
</div>\
|
|
||||||
<div class="arrow">\
|
|
||||||
<a href="#" id="dv<%id%>" class="vote" title="vote down">\
|
|
||||||
<img src="<%downArrow%>" id="da<%id%>" />\
|
|
||||||
</a>\
|
|
||||||
<a href="#" id="du<%id%>" class="un vote" title="vote down">\
|
|
||||||
<img src="<%downArrowPressed%>" />\
|
|
||||||
</a>\
|
|
||||||
</div>\
|
|
||||||
</div>\
|
|
||||||
<div class="comment-content">\
|
|
||||||
<p class="tagline comment">\
|
|
||||||
<span class="user-id"><%username%></span>\
|
|
||||||
<span class="rating"><%pretty_rating%></span>\
|
|
||||||
<span class="delta"><%time.delta%></span>\
|
|
||||||
</p>\
|
|
||||||
<div class="comment-text comment"><#text#></div>\
|
|
||||||
<p class="comment-opts comment">\
|
|
||||||
<a href="#" class="reply hidden" id="rl<%id%>">reply ▹</a>\
|
|
||||||
<a href="#" class="close-reply" id="cr<%id%>">reply ▿</a>\
|
|
||||||
<a href="#" id="sp<%id%>" class="show-proposal">proposal ▹</a>\
|
|
||||||
<a href="#" id="hp<%id%>" class="hide-proposal">proposal ▿</a>\
|
|
||||||
<a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
|
|
||||||
<span id="cm<%id%>" class="moderation hidden">\
|
|
||||||
<a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
|
|
||||||
</span>\
|
|
||||||
</p>\
|
|
||||||
<pre class="proposal" id="pr<%id%>">\
|
|
||||||
<#proposal_diff#>\
|
|
||||||
</pre>\
|
|
||||||
<ul class="comment-children" id="cl<%id%>"></ul>\
|
|
||||||
</div>\
|
|
||||||
<div class="clearleft"></div>\
|
|
||||||
</div>\
|
|
||||||
</div>';
|
|
||||||
|
|
||||||
var replyTemplate = '\
|
|
||||||
<li>\
|
|
||||||
<div class="reply-div" id="rd<%id%>">\
|
|
||||||
<form id="rf<%id%>">\
|
|
||||||
<textarea name="comment" cols="80"></textarea>\
|
|
||||||
<input type="submit" value="Add reply" />\
|
|
||||||
<input type="button" value="Cancel" />\
|
|
||||||
<input type="hidden" name="parent" value="<%id%>" />\
|
|
||||||
<input type="hidden" name="node" value="" />\
|
|
||||||
</form>\
|
|
||||||
</div>\
|
|
||||||
</li>';
|
|
||||||
|
|
||||||
$(document).ready(function() {
|
|
||||||
init();
|
|
||||||
});
|
|
||||||
})(jQuery);
|
|
||||||
|
|
||||||
$(document).ready(function() {
|
|
||||||
// add comment anchors for all paragraphs that are commentable
|
|
||||||
$('.sphinx-has-comment').comment();
|
|
||||||
|
|
||||||
// highlight search words in search results
|
|
||||||
$("div.context").each(function() {
|
|
||||||
var params = $.getQueryParameters();
|
|
||||||
var terms = (params.q) ? params.q[0].split(/\s+/) : [];
|
|
||||||
var result = $(this);
|
|
||||||
$.each(terms, function() {
|
|
||||||
result.highlightText(this.toLowerCase(), 'highlighted');
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// directly open comment window if requested
|
|
||||||
var anchor = document.location.hash;
|
|
||||||
if (anchor.substring(0, 9) == '#comment-') {
|
|
||||||
$('#ao' + anchor.substring(9)).click();
|
|
||||||
document.location.hash = '#s' + anchor.substring(9);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
@ -122,6 +122,7 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -138,6 +139,10 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="manual/creating-new-maps.html">Creating New Maps</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="manual/creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="manual/region-map-editor.html">The Region Map Editor</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="manual/region-map-editor.html">The Region Map Editor</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
|
||||||
|
|
@ -122,6 +122,7 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -138,6 +139,10 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="manual/creating-new-maps.html">Creating New Maps</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="manual/creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="manual/region-map-editor.html">The Region Map Editor</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="manual/region-map-editor.html">The Region Map Editor</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
@ -341,6 +346,7 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -357,6 +363,10 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="manual/creating-new-maps.html">Creating New Maps</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="manual/creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="manual/region-map-editor.html">The Region Map Editor</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="manual/region-map-editor.html">The Region Map Editor</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
|
||||||
403
docs/manual/creating-new-maps.html
Normal file
403
docs/manual/creating-new-maps.html
Normal file
|
|
@ -0,0 +1,403 @@
|
||||||
|
|
||||||
|
|
||||||
|
<!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>Creating New Maps — 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 src="../_static/jquery.js"></script>
|
||||||
|
<script src="../_static/underscore.js"></script>
|
||||||
|
<script src="../_static/doctools.js"></script>
|
||||||
|
<script 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="The Region Map Editor" href="region-map-editor.html" />
|
||||||
|
<link rel="prev" title="Editing Wild Encounters" href="editing-wild-encounters.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 & 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#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#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#adding-deleting-events">Adding & 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"><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 & 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 current"><a class="current reference internal" href="#">Creating New Maps</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#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>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</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#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-overlay-functions">Map Overlay 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#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>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></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#fixed">Fixed</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.0.0 - 2020-04-28</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#id2">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#id3">Fixed</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||||
|
<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">3.0.0 - 2020-03-04</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Breaking Changes</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Added</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Changed</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Fixed</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Breaking Changes</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Fixed</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Breaking Changes</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">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> »</li>
|
||||||
|
|
||||||
|
<li>Creating New Maps</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/manual/creating-new-maps.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="creating-new-maps">
|
||||||
|
<span id="id1"></span><h1>Creating New Maps<a class="headerlink" href="#creating-new-maps" title="Permalink to this headline">¶</a></h1>
|
||||||
|
<p>Creating a new map in porymap is easy! Just click <em>Tools -> New Map…</em>.
|
||||||
|
Alternatively, in any of the map list sort modes, you can right click on a folder
|
||||||
|
in order to add a new map to the folder.</p>
|
||||||
|
<p>For example, when sorting maps by their layout, you can add a new Pokemon Center from the existing layout.</p>
|
||||||
|
<div class="figure align-default" id="id2">
|
||||||
|
<img alt="Add New Map with Layout" src="../_images/right-click-layout-sort.png" />
|
||||||
|
<p class="caption"><span class="caption-text">Add New Map with Layout</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="new-map-options">
|
||||||
|
<h2>New Map Options<a class="headerlink" href="#new-map-options" title="Permalink to this headline">¶</a></h2>
|
||||||
|
<p>The popup window when you create a new map will display some options in order to customize your new map.</p>
|
||||||
|
<div class="figure align-default" id="id3">
|
||||||
|
<img alt="New Map Options Window" src="../_images/new-map-options-window.png" />
|
||||||
|
<p class="caption"><span class="caption-text">New Map Options Window</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
|
||||||
|
</div>
|
||||||
|
<p>The options you see may be different depending on your base project, but they are:</p>
|
||||||
|
<dl class="simple">
|
||||||
|
<dt>Name</dt><dd><p>The name of the new map. This cannot be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Group</dt><dd><p>Which map group the new map will beling to. This cannot be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Map Width</dt><dd><p>The width (in metatiles) of the map. This can be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Map Height</dt><dd><p>The height (in metatiles) of the map. This can be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Border Width</dt><dd><p>The width (in metatiles) of the map border blocks. This can be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Border Height</dt><dd><p>The height (in metatiles) of the map border blocks. This can be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Primary Tileset</dt><dd><p>The map’s primary tileset. This can be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Secondary Tileset</dt><dd><p>The map’s secondary tileset. This can be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Type</dt><dd><p>Whether this map is an indoor or outdoor map. This can be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Location</dt><dd><p>The region map section this map exists in. This can be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Can Fly To</dt><dd><p>Whether a heal location event will be created with this map. This cannot be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Allow Running</dt><dd><p>Whether the player can sprint on this map. This can be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Allow Biking</dt><dd><p>Whether the player can use the bike on this map. This can be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Allow Escape Rope</dt><dd><p>Whether the user can escape from this map. This can be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Floor Number</dt><dd><p>The floor number for this map if it is associated with an elevator. This can be changed in porymap.</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<footer>
|
||||||
|
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||||
|
|
||||||
|
<a href="region-map-editor.html" class="btn btn-neutral float-right" title="The Region Map Editor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
|
<a href="editing-wild-encounters.html" class="btn btn-neutral float-left" title="Editing Wild Encounters" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>
|
||||||
|
© Copyright 2020, 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>
|
||||||
|
|
@ -123,6 +123,7 @@
|
||||||
<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#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#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#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#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & 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>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -139,6 +140,10 @@
|
||||||
<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>
|
<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>
|
</ul>
|
||||||
</li>
|
</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-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#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-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
|
||||||
|
|
@ -123,6 +123,7 @@
|
||||||
<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#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#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#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#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & 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>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -139,6 +140,10 @@
|
||||||
<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>
|
<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>
|
</ul>
|
||||||
</li>
|
</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-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#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-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
|
||||||
|
|
@ -123,6 +123,7 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#sign-event">Sign Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="#sign-event">Sign Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#hidden-item-event">Hidden Item Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="#hidden-item-event">Hidden Item Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#secret-base-event">Secret Base Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="#secret-base-event">Secret Base Event</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#heal-location-healspots">Heal Location / Healspots</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#open-map-scripts">Open Map Scripts</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -139,6 +140,10 @@
|
||||||
<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>
|
<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>
|
</ul>
|
||||||
</li>
|
</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-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#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-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
@ -300,7 +305,7 @@
|
||||||
<img alt="Map Events View" src="../_images/map-events.png" />
|
<img alt="Map Events View" src="../_images/map-events.png" />
|
||||||
<p class="caption"><span class="caption-text">Map Events View</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
|
<p class="caption"><span class="caption-text">Map Events View</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
|
||||||
</div>
|
</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>
|
<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, simply 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 align-default" id="id2">
|
<div class="figure align-default" id="id2">
|
||||||
<img alt="Event Id Spinner" src="../_images/event-id-spinner.png" />
|
<img alt="Event Id Spinner" src="../_images/event-id-spinner.png" />
|
||||||
<p class="caption"><span class="caption-text">Event Id Spinner</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
|
<p class="caption"><span class="caption-text">Event Id Spinner</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
|
||||||
|
|
@ -339,10 +344,12 @@
|
||||||
</dd>
|
</dd>
|
||||||
<dt>Event Flag</dt><dd><p>The flag value that controls if the object is visible. If the flag is set (equal to 1), then the object will be invisible. If the Event Flag is set to <cite>0</cite>, then the object will always be visible because <cite>0</cite> means “no flag”.</p>
|
<dt>Event Flag</dt><dd><p>The flag value that controls if the object is visible. If the flag is set (equal to 1), then the object will be invisible. If the Event Flag is set to <cite>0</cite>, then the object will always be visible because <cite>0</cite> means “no flag”.</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt>Trainer Type</dt><dd><p><cite>NONE</cite>, <cite>NORMAL</cite>, or <cite>SEE ALL DIRECTIONS</cite>. If the object is a trainer, <cite>NORMAL</cite> means that the trainer will spot the player in the object’s line-of-sight.</p>
|
<dt>Trainer Type</dt><dd><p>The trainer type used by the object. If the object is a trainer, <cite>TRAINER_TYPE_NORMAL</cite> means that the trainer will spot the player in the object’s line-of-sight.</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt>Sight Radius or Berry Tree ID</dt><dd><p>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.</p>
|
<dt>Sight Radius or Berry Tree ID</dt><dd><p>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.</p>
|
||||||
</dd>
|
</dd>
|
||||||
|
<dt>In Connection</dt><dd><p>Exclusive to pokefirered. Used to replace objects that are visible in a map’s connection with their corresponding object on the connecting map. When checked, these objects will make odd use of other fields; its trainer type value will be the connecting map number, its Sight Radius / Berry Tree Id will be the connecting map group, and its z coordinate will be the object’s local id on the connecting map.</p>
|
||||||
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="warp-events">
|
<div class="section" id="warp-events">
|
||||||
|
|
@ -381,7 +388,7 @@
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="weather-trigger-events">
|
<div class="section" id="weather-trigger-events">
|
||||||
<h2>Weather Trigger Events<a class="headerlink" href="#weather-trigger-events" title="Permalink to this headline">¶</a></h2>
|
<h2>Weather Trigger Events<a class="headerlink" href="#weather-trigger-events" title="Permalink to this headline">¶</a></h2>
|
||||||
<p>Weather trigger events 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>
|
<p>Weather trigger events 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. This event type is unavailable for pokefirered projects; the functions to trigger weather changes were dummied out.</p>
|
||||||
<div class="figure align-default" id="id7">
|
<div class="figure align-default" id="id7">
|
||||||
<img alt="Weather Trigger Event Properties" src="../_images/event-weather-trigger.png" />
|
<img alt="Weather Trigger Event Properties" src="../_images/event-weather-trigger.png" />
|
||||||
<p class="caption"><span class="caption-text">Weather Trigger Event Properties</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
|
<p class="caption"><span class="caption-text">Weather Trigger Event Properties</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
|
||||||
|
|
@ -423,11 +430,16 @@
|
||||||
</dd>
|
</dd>
|
||||||
<dt>Flag</dt><dd><p>This flag is set when the player receives the hidden item.</p>
|
<dt>Flag</dt><dd><p>This flag is set when the player receives the hidden item.</p>
|
||||||
</dd>
|
</dd>
|
||||||
|
<dt>Quantity</dt><dd><p>Exclusive to pokefirered. The number of items received when the item is picked up.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Requires Itemfinder</dt><dd><p>Exclusive to pokefirered. When checked, the hidden item can only be received by standing on it and using the Itemfinder.</p>
|
||||||
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="secret-base-event">
|
<div class="section" id="secret-base-event">
|
||||||
<h2>Secret Base Event<a class="headerlink" href="#secret-base-event" title="Permalink to this headline">¶</a></h2>
|
<h2>Secret Base Event<a class="headerlink" href="#secret-base-event" 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>
|
<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>).
|
||||||
|
This event type is unavailable for pokefirered projects; secret bases do not exist there.</p>
|
||||||
<div class="figure align-default" id="id10">
|
<div class="figure align-default" id="id10">
|
||||||
<img alt="Secret Base Event Properties" src="../_images/event-secret-base.png" />
|
<img alt="Secret Base Event Properties" src="../_images/event-secret-base.png" />
|
||||||
<p class="caption"><span class="caption-text">Secret Base Event Properties</span><a class="headerlink" href="#id10" title="Permalink to this image">¶</a></p>
|
<p class="caption"><span class="caption-text">Secret Base Event Properties</span><a class="headerlink" href="#id10" title="Permalink to this image">¶</a></p>
|
||||||
|
|
@ -439,6 +451,20 @@
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="section" id="heal-location-healspots">
|
||||||
|
<h2>Heal Location / Healspots<a class="headerlink" href="#heal-location-healspots" title="Permalink to this headline">¶</a></h2>
|
||||||
|
<p>This event is used to control where a player will arrive when they white out or fly to the map. The white out functions a little differently between game versions. For pokeemerald and pokeruby players will arrive at the event’s coordinates after a white out, while in pokefirered they will arrive on the map set in <code class="docutils literal notranslate"><span class="pre">Respawn</span> <span class="pre">Map</span></code> and at hardcoded coordinates (see <code class="docutils literal notranslate"><span class="pre">SetWhiteoutRespawnWarpAndHealerNpc</span></code> in <code class="docutils literal notranslate"><span class="pre">src/heal_location.c</span></code>).</p>
|
||||||
|
<div class="figure align-default" id="id11">
|
||||||
|
<img alt="Heal Location Properties" src="../_images/event-heal-location.png" />
|
||||||
|
<p class="caption"><span class="caption-text">Heal Location Properties</span><a class="headerlink" href="#id11" title="Permalink to this image">¶</a></p>
|
||||||
|
</div>
|
||||||
|
<dl class="simple">
|
||||||
|
<dt>Respawn Map</dt><dd><p>Exclusive to pokefirered. The map where the player will arrive when they white out (e.g. inside the PokéCenter that the heal location is in front of).</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Respawn NPC</dt><dd><p>Exclusive to pokefirered. The local id of the NPC the player will interact with when they white out.</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div>
|
||||||
<div class="section" id="adding-deleting-events">
|
<div class="section" id="adding-deleting-events">
|
||||||
<h2>Adding & Deleting Events<a class="headerlink" href="#adding-deleting-events" title="Permalink to this headline">¶</a></h2>
|
<h2>Adding & Deleting Events<a class="headerlink" href="#adding-deleting-events" title="Permalink to this headline">¶</a></h2>
|
||||||
<p>To add a new event, press the green plus button. <img alt="add-event-button" src="../_images/add-event-button.png" /> You can choose between the different types of events by clicking the small arrow on the right.</p>
|
<p>To add a new event, press the green plus button. <img alt="add-event-button" src="../_images/add-event-button.png" /> You can choose between the different types of events by clicking the small arrow on the right.</p>
|
||||||
|
|
|
||||||
|
|
@ -123,6 +123,7 @@
|
||||||
<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#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#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#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#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & 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>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -139,6 +140,10 @@
|
||||||
<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>
|
<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>
|
</ul>
|
||||||
</li>
|
</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-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#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-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
@ -309,7 +314,7 @@
|
||||||
</dd>
|
</dd>
|
||||||
<dt>Weather</dt><dd><p>The weather that is running when entering the map.</p>
|
<dt>Weather</dt><dd><p>The weather that is running when entering the map.</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt>Type</dt><dd><p>The type of map. This value is used by various things in the game engine. For example, in Ruby Version, running shoes can only be used when the map type is <code class="docutils literal notranslate"><span class="pre">MAP_TYPE_INDOOR</span></code>.</p>
|
<dt>Type</dt><dd><p>The type of map. This value is used by various things in the game engine. For example, in Ruby Version, running shoes cannot be used when the map type is <code class="docutils literal notranslate"><span class="pre">MAP_TYPE_INDOOR</span></code>.</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt>Battle Scene</dt><dd><p>Controls what graphics are used in battles.</p>
|
<dt>Battle Scene</dt><dd><p>Controls what graphics are used in battles.</p>
|
||||||
</dd>
|
</dd>
|
||||||
|
|
@ -319,7 +324,9 @@
|
||||||
</dd>
|
</dd>
|
||||||
<dt>Allow Biking</dt><dd><p>Controls whether or not a bike can be used.</p>
|
<dt>Allow Biking</dt><dd><p>Controls whether or not a bike can be used.</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt>Allow Dig & Escape Rop</dt><dd><p>Controls whether the Dig field move or the Escape Rope item can be used.</p>
|
<dt>Allow Dig & Escape Rope</dt><dd><p>Controls whether the Dig field move or the Escape Rope item can be used.</p>
|
||||||
|
</dd>
|
||||||
|
<dt>Floor Number</dt><dd><p>Exclusive to pokefirered. Used to append a number to the map name popup. Negative values are prefixed with “B” for basement, and floor 127 is “Rooftop”.</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt>Custom Fields</dt><dd><p>You can enter custom fields if you need support for additional fields in your project. They can also be useful for keeping notes.</p>
|
<dt>Custom Fields</dt><dd><p>You can enter custom fields if you need support for additional fields in your project. They can also be useful for keeping notes.</p>
|
||||||
</dd>
|
</dd>
|
||||||
|
|
|
||||||
|
|
@ -123,6 +123,7 @@
|
||||||
<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#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#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#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#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & 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>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -139,6 +140,10 @@
|
||||||
<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>
|
<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>
|
</ul>
|
||||||
</li>
|
</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-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#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-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
@ -389,6 +394,7 @@
|
||||||
<img alt="Change Map Border" src="../_images/map-border.png" />
|
<img alt="Change Map Border" src="../_images/map-border.png" />
|
||||||
<p class="caption"><span class="caption-text">Change Map Border</span><a class="headerlink" href="#id13" title="Permalink to this image">¶</a></p>
|
<p class="caption"><span class="caption-text">Change Map Border</span><a class="headerlink" href="#id13" title="Permalink to this image">¶</a></p>
|
||||||
</div>
|
</div>
|
||||||
|
<p>The dimensions of the map’s border can also be adjusted for pokefirered projects via the <code class="docutils literal notranslate"><span class="pre">Change</span> <span class="pre">Dimensions</span></code> button. If you have modified your pokeemerald or pokeruby project to support custom border sizes you can enable this option with the <code class="docutils literal notranslate"><span class="pre">use_custom_border_size</span></code> field in your project’s <code class="docutils literal notranslate"><span class="pre">porymap.project.cfg</span></code> file.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="change-map-tilesets">
|
<div class="section" id="change-map-tilesets">
|
||||||
<h2>Change Map Tilesets<a class="headerlink" href="#change-map-tilesets" title="Permalink to this headline">¶</a></h2>
|
<h2>Change Map Tilesets<a class="headerlink" href="#change-map-tilesets" title="Permalink to this headline">¶</a></h2>
|
||||||
|
|
|
||||||
|
|
@ -36,7 +36,7 @@
|
||||||
<link rel="stylesheet" href="../_static/css/custom.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="index" title="Index" href="../genindex.html" />
|
||||||
<link rel="search" title="Search" href="../search.html" />
|
<link rel="search" title="Search" href="../search.html" />
|
||||||
<link rel="next" title="The Region Map Editor" href="region-map-editor.html" />
|
<link rel="next" title="Creating New Maps" href="creating-new-maps.html" />
|
||||||
<link rel="prev" title="Editing Map Connections" href="editing-map-connections.html" />
|
<link rel="prev" title="Editing Map Connections" href="editing-map-connections.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
|
|
@ -123,6 +123,7 @@
|
||||||
<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#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#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#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#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & 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>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -139,6 +140,10 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</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-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#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-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
@ -385,7 +390,7 @@ the levels.</p>
|
||||||
|
|
||||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||||
|
|
||||||
<a href="region-map-editor.html" class="btn btn-neutral float-right" title="The Region Map Editor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="creating-new-maps.html" class="btn btn-neutral float-right" title="Creating New Maps" 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-left" title="Editing Map Connections" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="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>
|
||||||
|
|
|
||||||
|
|
@ -123,6 +123,7 @@
|
||||||
<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#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#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#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#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & 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>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -139,6 +140,10 @@
|
||||||
<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>
|
<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>
|
</ul>
|
||||||
</li>
|
</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-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#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-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
@ -303,7 +308,7 @@
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="getting-started">
|
<div class="section" id="getting-started">
|
||||||
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
|
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
|
||||||
<p>Before using Porymap, you must have your decompilation project setup. Porymap currently supports <a class="reference external" href="https://github.com/pret/pokeemerald">pokeemerald</a> and <a class="reference external" href="https://github.com/pret/pokeruby">pokeruby</a>. See their respective <code class="docutils literal notranslate"><span class="pre">INSTALL.md</span></code> files to get setup, and make sure you can successfully compile the ROM.</p>
|
<p>Before using Porymap, you must have your decompilation project setup. Porymap supports the <a class="reference external" href="https://github.com/pret/pokeemerald">pokeemerald</a>, <a class="reference external" href="https://github.com/pret/pokeruby">pokeruby</a>, and <a class="reference external" href="https://github.com/pret/pokefirered">pokefirered</a> decompilation projects. See their respective <code class="docutils literal notranslate"><span class="pre">INSTALL.md</span></code> files to get setup, and make sure you can successfully compile the ROM.</p>
|
||||||
<p>When launching Porymap for the first time, you will be greeted with the following empty window:</p>
|
<p>When launching Porymap for the first time, you will be greeted with the following empty window:</p>
|
||||||
<div class="figure align-default" id="id1">
|
<div class="figure align-default" id="id1">
|
||||||
<img alt="Porymap Empty Window" src="../_images/porymap-empty-window.png" />
|
<img alt="Porymap Empty Window" src="../_images/porymap-empty-window.png" />
|
||||||
|
|
|
||||||
|
|
@ -123,6 +123,7 @@
|
||||||
<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#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#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#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#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & 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>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -139,6 +140,10 @@
|
||||||
<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>
|
<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>
|
</ul>
|
||||||
</li>
|
</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-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#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-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
@ -312,6 +317,7 @@
|
||||||
<dt>Sort by Layout</dt><dd><p>Organizes by map layouts. Most layouts are only used by a single map, but layouts like the Pokemon Center are used by many maps.</p>
|
<dt>Sort by Layout</dt><dd><p>Organizes by map layouts. Most layouts are only used by a single map, but layouts like the Pokemon Center are used by many maps.</p>
|
||||||
</dd>
|
</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
<p>Right-clicking on the folder name in any of the sort modes will bring up a dialog to create a new map in that folder. For more details, see: <a class="reference internal" href="creating-new-maps.html#creating-new-maps"><span class="std std-ref">Creating New Maps</span></a>.</p>
|
||||||
<p>The <em>Expand All</em> <img alt="expand-all-button" src="../_images/expand-all-button.png" /> and <em>Collapse All</em> <img alt="collapse-all-button" src="../_images/collapse-all-button.png" /> buttons will expand or collapse all of the map folders.</p>
|
<p>The <em>Expand All</em> <img alt="expand-all-button" src="../_images/expand-all-button.png" /> and <em>Collapse All</em> <img alt="collapse-all-button" src="../_images/collapse-all-button.png" /> buttons will expand or collapse all of the map folders.</p>
|
||||||
<p>Type in the filter to show maps that contain the filter text.</p>
|
<p>Type in the filter to show maps that contain the filter text.</p>
|
||||||
<div class="figure align-default" id="id2">
|
<div class="figure align-default" id="id2">
|
||||||
|
|
@ -349,7 +355,7 @@
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="region-map-editor">
|
<div class="section" id="region-map-editor">
|
||||||
<h2>Region Map Editor<a class="headerlink" href="#region-map-editor" title="Permalink to this headline">¶</a></h2>
|
<h2>Region Map Editor<a class="headerlink" href="#region-map-editor" title="Permalink to this headline">¶</a></h2>
|
||||||
<p>The Region Map Editor can be opened with <em>File -> Region Map Editor</em>. This window will allow you to modify the look and layout of maps on the game’s region map. You can also modify the city map images using the bottom two panes.</p>
|
<p>The Region Map Editor can be opened with <em>File -> Region Map Editor</em>. This window will allow you to modify the look and layout of maps on the game’s region map. You can also modify the city map images using the bottom two panes. Currently the Region Map Editor is only available for pokeemerald and pokeruby projects.</p>
|
||||||
<div class="figure align-default" id="id5">
|
<div class="figure align-default" id="id5">
|
||||||
<img alt="Region Map Editor" src="../_images/region-map-editor.png" />
|
<img alt="Region Map Editor" src="../_images/region-map-editor.png" />
|
||||||
<p class="caption"><span class="caption-text">Region Map Editor</span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
|
<p class="caption"><span class="caption-text">Region Map Editor</span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
|
||||||
|
|
|
||||||
|
|
@ -123,6 +123,7 @@
|
||||||
<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#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#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#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#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & 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>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -139,6 +140,10 @@
|
||||||
<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>
|
<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>
|
</ul>
|
||||||
</li>
|
</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-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#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-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
@ -353,22 +358,22 @@ to a file, it probably is not a good idea to edit yourself unless otherwise note
|
||||||
<td><p>yes</p></td>
|
<td><p>yes</p></td>
|
||||||
<td></td>
|
<td></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><p>src/data/field_event_obj/event_object_graphics_info_pointers.h</p></td>
|
<tr class="row-even"><td><p>src/data/object_events/object_event_graphics_info_pointers.h</p></td>
|
||||||
<td><p>yes</p></td>
|
<td><p>yes</p></td>
|
||||||
<td><p>no</p></td>
|
<td><p>no</p></td>
|
||||||
<td></td>
|
<td></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><p>src/data/field_event_obj/event_object_graphics_info.h</p></td>
|
<tr class="row-odd"><td><p>src/data/object_events/object_event_graphics_info.h</p></td>
|
||||||
<td><p>yes</p></td>
|
<td><p>yes</p></td>
|
||||||
<td><p>no</p></td>
|
<td><p>no</p></td>
|
||||||
<td></td>
|
<td></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><p>src/data/field_event_obj/event_object_pic_tables.h</p></td>
|
<tr class="row-even"><td><p>src/data/object_events/object_event_pic_tables.h</p></td>
|
||||||
<td><p>yes</p></td>
|
<td><p>yes</p></td>
|
||||||
<td><p>no</p></td>
|
<td><p>no</p></td>
|
||||||
<td></td>
|
<td></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><p>src/data/field_event_obj/event_object_graphics.h</p></td>
|
<tr class="row-odd"><td><p>src/data/object_events/object_event_graphics.h</p></td>
|
||||||
<td><p>yes</p></td>
|
<td><p>yes</p></td>
|
||||||
<td><p>no</p></td>
|
<td><p>no</p></td>
|
||||||
<td></td>
|
<td></td>
|
||||||
|
|
@ -428,37 +433,37 @@ to a file, it probably is not a good idea to edit yourself unless otherwise note
|
||||||
<td><p>no</p></td>
|
<td><p>no</p></td>
|
||||||
<td></td>
|
<td></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><p>include/constants/secret_bases.h</p></td>
|
<tr class="row-odd"><td><p>include/constants/trainer_types.h</p></td>
|
||||||
<td><p>yes</p></td>
|
<td><p>yes</p></td>
|
||||||
<td><p>no</p></td>
|
<td><p>no</p></td>
|
||||||
<td></td>
|
<td></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><p>include/constants/event_object_movement_constants.h</p></td>
|
<tr class="row-even"><td><p>include/constants/secret_bases.h</p></td>
|
||||||
|
<td><p>yes</p></td>
|
||||||
|
<td><p>no</p></td>
|
||||||
|
<td><p>pokeemerald and pokeruby only</p></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><p>include/constants/event_object_movement.h</p></td>
|
||||||
<td><p>yes</p></td>
|
<td><p>yes</p></td>
|
||||||
<td><p>no</p></td>
|
<td><p>no</p></td>
|
||||||
<td></td>
|
<td></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><p>include/constants/bg_event_constants.h</p></td>
|
<tr class="row-even"><td><p>include/constants/event_bg.h</p></td>
|
||||||
<td><p>yes</p></td>
|
<td><p>yes</p></td>
|
||||||
<td><p>no</p></td>
|
<td><p>no</p></td>
|
||||||
<td></td>
|
<td></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><p>include/constants/region_map_sections.h</p></td>
|
<tr class="row-odd"><td><p>include/constants/region_map_sections.h</p></td>
|
||||||
<td><p>yes</p></td>
|
<td><p>yes</p></td>
|
||||||
<td><p>no</p></td>
|
<td><p>no</p></td>
|
||||||
<td></td>
|
<td></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><p>include/constants/metatile_labels.h</p></td>
|
<tr class="row-even"><td><p>include/constants/metatile_labels.h</p></td>
|
||||||
<td><p>yes</p></td>
|
<td><p>yes</p></td>
|
||||||
<td><p>yes</p></td>
|
<td><p>yes</p></td>
|
||||||
<td></td>
|
<td></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><p>include/constants/metatile_behaviors.h</p></td>
|
<tr class="row-odd"><td><p>include/constants/metatile_behaviors.h</p></td>
|
||||||
<td><p>yes</p></td>
|
|
||||||
<td><p>no</p></td>
|
|
||||||
<td></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><p>include/constants/bg_event_constants.h</p></td>
|
|
||||||
<td><p>yes</p></td>
|
<td><p>yes</p></td>
|
||||||
<td><p>no</p></td>
|
<td><p>no</p></td>
|
||||||
<td></td>
|
<td></td>
|
||||||
|
|
|
||||||
|
|
@ -37,7 +37,7 @@
|
||||||
<link rel="index" title="Index" href="../genindex.html" />
|
<link rel="index" title="Index" href="../genindex.html" />
|
||||||
<link rel="search" title="Search" href="../search.html" />
|
<link rel="search" title="Search" href="../search.html" />
|
||||||
<link rel="next" title="Scripting Capabilities" href="scripting-capabilities.html" />
|
<link rel="next" title="Scripting Capabilities" href="scripting-capabilities.html" />
|
||||||
<link rel="prev" title="Editing Wild Encounters" href="editing-wild-encounters.html" />
|
<link rel="prev" title="Creating New Maps" href="creating-new-maps.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
@ -123,6 +123,7 @@
|
||||||
<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#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#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#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#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & 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>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -139,6 +140,10 @@
|
||||||
<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>
|
<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>
|
</ul>
|
||||||
</li>
|
</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 current"><a class="current reference internal" href="#">The Region Map Editor</a><ul>
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">The Region Map Editor</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#background-image-tab">Background Image Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="#background-image-tab">Background Image Tab</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#map-layout-tab">Map Layout Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="#map-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
@ -297,6 +302,10 @@
|
||||||
<h1>The Region Map Editor<a class="headerlink" href="#the-region-map-editor" title="Permalink to this headline">¶</a></h1>
|
<h1>The Region Map Editor<a class="headerlink" href="#the-region-map-editor" title="Permalink to this headline">¶</a></h1>
|
||||||
<p>This is where you edit the region map for your game. To open the region map
|
<p>This is where you edit the region map for your game. To open the region map
|
||||||
editor, navigate to <em>Tools -> Region Map Editor</em> from porymap’s main window.</p>
|
editor, navigate to <em>Tools -> Region Map Editor</em> from porymap’s main window.</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>The region map editor is currently only available for pokeemerald and pokeruby.</p>
|
||||||
|
</div>
|
||||||
<p>When you first open the region map editor, your window will look like this:</p>
|
<p>When you first open the region map editor, your window will look like this:</p>
|
||||||
<div class="figure align-center" id="id4">
|
<div class="figure align-center" id="id4">
|
||||||
<a class="reference internal image-reference" href="../_images/rme-new-window.png"><img alt="RME Window" src="../_images/rme-new-window.png" style="width: 621.75px; height: 499.5px;" /></a>
|
<a class="reference internal image-reference" href="../_images/rme-new-window.png"><img alt="RME Window" src="../_images/rme-new-window.png" style="width: 621.75px; height: 499.5px;" /></a>
|
||||||
|
|
@ -407,7 +416,7 @@ but that functionality will be added in a future update.</p>
|
||||||
<a href="scripting-capabilities.html" class="btn btn-neutral float-right" title="Scripting Capabilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="scripting-capabilities.html" class="btn btn-neutral float-right" title="Scripting Capabilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="editing-wild-encounters.html" class="btn btn-neutral float-left" title="Editing Wild Encounters" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="creating-new-maps.html" class="btn btn-neutral float-left" title="Creating New Maps" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -123,6 +123,7 @@
|
||||||
<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#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#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#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#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & 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>
|
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -139,6 +140,10 @@
|
||||||
<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>
|
<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>
|
</ul>
|
||||||
</li>
|
</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-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#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-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
@ -367,7 +372,7 @@
|
||||||
<h2>Scripting API<a class="headerlink" href="#scripting-api" title="Permalink to this headline">¶</a></h2>
|
<h2>Scripting API<a class="headerlink" href="#scripting-api" title="Permalink to this headline">¶</a></h2>
|
||||||
<div class="section" id="callbacks">
|
<div class="section" id="callbacks">
|
||||||
<h3>Callbacks<a class="headerlink" href="#callbacks" title="Permalink to this headline">¶</a></h3>
|
<h3>Callbacks<a class="headerlink" href="#callbacks" title="Permalink to this headline">¶</a></h3>
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="onProjectOpened">
|
<dt id="onProjectOpened">
|
||||||
<code class="sig-name descname">onProjectOpened</code><span class="sig-paren">(</span><em class="sig-param">projectPath</em><span class="sig-paren">)</span><a class="headerlink" href="#onProjectOpened" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">onProjectOpened</code><span class="sig-paren">(</span><em class="sig-param">projectPath</em><span class="sig-paren">)</span><a class="headerlink" href="#onProjectOpened" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Called when Porymap successfully opens a project.</p>
|
<dd><p>Called when Porymap successfully opens a project.</p>
|
||||||
|
|
@ -380,7 +385,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="onProjectClosed">
|
<dt id="onProjectClosed">
|
||||||
<code class="sig-name descname">onProjectClosed</code><span class="sig-paren">(</span><em class="sig-param">projectPath</em><span class="sig-paren">)</span><a class="headerlink" href="#onProjectClosed" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">onProjectClosed</code><span class="sig-paren">(</span><em class="sig-param">projectPath</em><span class="sig-paren">)</span><a class="headerlink" href="#onProjectClosed" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Called when Porymap closes a project. For example, this is called when opening a different project.</p>
|
<dd><p>Called when Porymap closes a project. For example, this is called when opening a different project.</p>
|
||||||
|
|
@ -393,7 +398,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="onMapOpened">
|
<dt id="onMapOpened">
|
||||||
<code class="sig-name descname">onMapOpened</code><span class="sig-paren">(</span><em class="sig-param">mapName</em><span class="sig-paren">)</span><a class="headerlink" href="#onMapOpened" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">onMapOpened</code><span class="sig-paren">(</span><em class="sig-param">mapName</em><span class="sig-paren">)</span><a class="headerlink" href="#onMapOpened" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Called when a map is opened.</p>
|
<dd><p>Called when a map is opened.</p>
|
||||||
|
|
@ -406,7 +411,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="onBlockChanged">
|
<dt id="onBlockChanged">
|
||||||
<code class="sig-name descname">onBlockChanged</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">prevBlock</em>, <em class="sig-param">newBlock</em><span class="sig-paren">)</span><a class="headerlink" href="#onBlockChanged" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">onBlockChanged</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">prevBlock</em>, <em class="sig-param">newBlock</em><span class="sig-paren">)</span><a class="headerlink" href="#onBlockChanged" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Called when a block is changed on the map. For example, this is called when a user paints a new tile or changes the collision property of a block.</p>
|
<dd><p>Called when a block is changed on the map. For example, this is called when a user paints a new tile or changes the collision property of a block.</p>
|
||||||
|
|
@ -429,7 +434,7 @@
|
||||||
<div class="section" id="map-editing-functions">
|
<div class="section" id="map-editing-functions">
|
||||||
<h4>Map Editing Functions<a class="headerlink" href="#map-editing-functions" title="Permalink to this headline">¶</a></h4>
|
<h4>Map Editing Functions<a class="headerlink" href="#map-editing-functions" title="Permalink to this headline">¶</a></h4>
|
||||||
<p>The following functions are related to editing the map’s blocks or retrieving information about them.</p>
|
<p>The following functions are related to editing the map’s blocks or retrieving information about them.</p>
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getBlock">
|
<dt id="map.getBlock">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getBlock</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getBlock" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getBlock</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getBlock" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets a block in the currently-opened map.</p>
|
<dd><p>Gets a block in the currently-opened map.</p>
|
||||||
|
|
@ -446,7 +451,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setBlock">
|
<dt id="map.setBlock">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setBlock</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">metatileId</em>, <em class="sig-param">collision</em>, <em class="sig-param">elevation</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setBlock" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setBlock</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">metatileId</em>, <em class="sig-param">collision</em>, <em class="sig-param">elevation</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setBlock" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets a block in the currently-opened map.</p>
|
<dd><p>Sets a block in the currently-opened map.</p>
|
||||||
|
|
@ -463,7 +468,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getMetatileId">
|
<dt id="map.getMetatileId">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getMetatileId</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getMetatileId" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getMetatileId</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getMetatileId" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets the metatile id of a block in the currently-opened map.</p>
|
<dd><p>Gets the metatile id of a block in the currently-opened map.</p>
|
||||||
|
|
@ -480,7 +485,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setMetatileId">
|
<dt id="map.setMetatileId">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setMetatileId</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">metatileId</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setMetatileId" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setMetatileId</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">metatileId</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setMetatileId" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets the metatile id of a block in the currently-opened map.</p>
|
<dd><p>Sets the metatile id of a block in the currently-opened map.</p>
|
||||||
|
|
@ -495,7 +500,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getCollision">
|
<dt id="map.getCollision">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getCollision</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getCollision" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getCollision</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getCollision" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets the collision of a block in the currently-opened map. (<code class="docutils literal notranslate"><span class="pre">0</span></code> = passable, <code class="docutils literal notranslate"><span class="pre">1</span></code> = impassable)</p>
|
<dd><p>Gets the collision of a block in the currently-opened map. (<code class="docutils literal notranslate"><span class="pre">0</span></code> = passable, <code class="docutils literal notranslate"><span class="pre">1</span></code> = impassable)</p>
|
||||||
|
|
@ -512,7 +517,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setCollision">
|
<dt id="map.setCollision">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setCollision</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">collision</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setCollision" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setCollision</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">collision</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setCollision" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets the collision of a block in the currently-opened map. (<code class="docutils literal notranslate"><span class="pre">0</span></code> = passable, <code class="docutils literal notranslate"><span class="pre">1</span></code> = impassable)</p>
|
<dd><p>Sets the collision of a block in the currently-opened map. (<code class="docutils literal notranslate"><span class="pre">0</span></code> = passable, <code class="docutils literal notranslate"><span class="pre">1</span></code> = impassable)</p>
|
||||||
|
|
@ -527,7 +532,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getElevation">
|
<dt id="map.getElevation">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getElevation</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getElevation" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getElevation</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getElevation" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets the elevation of a block in the currently-opened map.</p>
|
<dd><p>Gets the elevation of a block in the currently-opened map.</p>
|
||||||
|
|
@ -544,7 +549,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setElevation">
|
<dt id="map.setElevation">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setElevation</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">elevation</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setElevation" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setElevation</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">elevation</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setElevation" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets the elevation of a block in the currently-opened map.</p>
|
<dd><p>Sets the elevation of a block in the currently-opened map.</p>
|
||||||
|
|
@ -559,7 +564,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setBlocksFromSelection">
|
<dt id="map.setBlocksFromSelection">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setBlocksFromSelection</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setBlocksFromSelection" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setBlocksFromSelection</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setBlocksFromSelection" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets blocks on the map using the user’s current metatile selection.</p>
|
<dd><p>Sets blocks on the map using the user’s current metatile selection.</p>
|
||||||
|
|
@ -573,7 +578,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.bucketFill">
|
<dt id="map.bucketFill">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">bucketFill</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">metatileId</em><span class="sig-paren">)</span><a class="headerlink" href="#map.bucketFill" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">bucketFill</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">metatileId</em><span class="sig-paren">)</span><a class="headerlink" href="#map.bucketFill" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Performs a bucket fill of a metatile id, starting at the given coordinates.</p>
|
<dd><p>Performs a bucket fill of a metatile id, starting at the given coordinates.</p>
|
||||||
|
|
@ -588,7 +593,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.bucketFillFromSelection">
|
<dt id="map.bucketFillFromSelection">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">bucketFillFromSelection</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.bucketFillFromSelection" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">bucketFillFromSelection</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.bucketFillFromSelection" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Performs a bucket fill using the user’s current metatile selection, starting at the given coordinates.</p>
|
<dd><p>Performs a bucket fill using the user’s current metatile selection, starting at the given coordinates.</p>
|
||||||
|
|
@ -602,7 +607,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.magicFill">
|
<dt id="map.magicFill">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">magicFill</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">metatileId</em><span class="sig-paren">)</span><a class="headerlink" href="#map.magicFill" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">magicFill</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">metatileId</em><span class="sig-paren">)</span><a class="headerlink" href="#map.magicFill" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Performs a magic fill of a metatile id, starting at the given coordinates.</p>
|
<dd><p>Performs a magic fill of a metatile id, starting at the given coordinates.</p>
|
||||||
|
|
@ -617,7 +622,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.magicFillFromSelection">
|
<dt id="map.magicFillFromSelection">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">magicFillFromSelection</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.magicFillFromSelection" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">magicFillFromSelection</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#map.magicFillFromSelection" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Performs a magic fill using the user’s current metatile selection, starting at the given coordinates.</p>
|
<dd><p>Performs a magic fill using the user’s current metatile selection, starting at the given coordinates.</p>
|
||||||
|
|
@ -631,7 +636,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.shift">
|
<dt id="map.shift">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">shift</code><span class="sig-paren">(</span><em class="sig-param">xDelta</em>, <em class="sig-param">yDelta</em><span class="sig-paren">)</span><a class="headerlink" href="#map.shift" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">shift</code><span class="sig-paren">(</span><em class="sig-param">xDelta</em>, <em class="sig-param">yDelta</em><span class="sig-paren">)</span><a class="headerlink" href="#map.shift" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Performs a shift on the map’s blocks.</p>
|
<dd><p>Performs a shift on the map’s blocks.</p>
|
||||||
|
|
@ -645,7 +650,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getDimensions">
|
<dt id="map.getDimensions">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getDimensions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getDimensions" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getDimensions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getDimensions" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets the dimensions of the currently-opened map.</p>
|
<dd><p>Gets the dimensions of the currently-opened map.</p>
|
||||||
|
|
@ -656,7 +661,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getWidth">
|
<dt id="map.getWidth">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getWidth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getWidth" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getWidth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getWidth" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets the width of the currently-opened map.</p>
|
<dd><p>Gets the width of the currently-opened map.</p>
|
||||||
|
|
@ -667,7 +672,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getHeight">
|
<dt id="map.getHeight">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getHeight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getHeight" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getHeight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getHeight" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets the height of the currently-opened map.</p>
|
<dd><p>Gets the height of the currently-opened map.</p>
|
||||||
|
|
@ -678,7 +683,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setDimensions">
|
<dt id="map.setDimensions">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setDimensions</code><span class="sig-paren">(</span><em class="sig-param">width</em>, <em class="sig-param">height</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setDimensions" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setDimensions</code><span class="sig-paren">(</span><em class="sig-param">width</em>, <em class="sig-param">height</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setDimensions" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets the dimensions of the currently-opened map.</p>
|
<dd><p>Sets the dimensions of the currently-opened map.</p>
|
||||||
|
|
@ -692,7 +697,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setWidth">
|
<dt id="map.setWidth">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setWidth</code><span class="sig-paren">(</span><em class="sig-param">width</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setWidth" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setWidth</code><span class="sig-paren">(</span><em class="sig-param">width</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setWidth" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets the width of the currently-opened map.</p>
|
<dd><p>Sets the width of the currently-opened map.</p>
|
||||||
|
|
@ -705,7 +710,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setHeight">
|
<dt id="map.setHeight">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setHeight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.setHeight" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setHeight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.setHeight" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets the height of the currently-opened map.</p>
|
<dd><p>Sets the height of the currently-opened map.</p>
|
||||||
|
|
@ -722,13 +727,13 @@
|
||||||
<div class="section" id="map-overlay-functions">
|
<div class="section" id="map-overlay-functions">
|
||||||
<h4>Map Overlay Functions<a class="headerlink" href="#map-overlay-functions" title="Permalink to this headline">¶</a></h4>
|
<h4>Map Overlay Functions<a class="headerlink" href="#map-overlay-functions" title="Permalink to this headline">¶</a></h4>
|
||||||
<p>The following functions are related to an overlay that is drawn on top of the map area. Text, images, and shapes can be drawn using these functions.</p>
|
<p>The following functions are related to an overlay that is drawn on top of the map area. Text, images, and shapes can be drawn using these functions.</p>
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.clearOverlay">
|
<dt id="map.clearOverlay">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">clearOverlay</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.clearOverlay" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">clearOverlay</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.clearOverlay" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Clears and erases all overlay items that were previously-added to the map.</p>
|
<dd><p>Clears and erases all overlay items that were previously-added to the map.</p>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.addText">
|
<dt id="map.addText">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">addText</code><span class="sig-paren">(</span><em class="sig-param">text</em>, <em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">color = "#000000"</em>, <em class="sig-param">size = 12</em><span class="sig-paren">)</span><a class="headerlink" href="#map.addText" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">addText</code><span class="sig-paren">(</span><em class="sig-param">text</em>, <em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">color = "#000000"</em>, <em class="sig-param">size = 12</em><span class="sig-paren">)</span><a class="headerlink" href="#map.addText" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Adds a text item to the overlay.</p>
|
<dd><p>Adds a text item to the overlay.</p>
|
||||||
|
|
@ -745,7 +750,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.addRect">
|
<dt id="map.addRect">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">addRect</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">width</em>, <em class="sig-param">height</em>, <em class="sig-param">color = "#000000"</em><span class="sig-paren">)</span><a class="headerlink" href="#map.addRect" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">addRect</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">width</em>, <em class="sig-param">height</em>, <em class="sig-param">color = "#000000"</em><span class="sig-paren">)</span><a class="headerlink" href="#map.addRect" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Adds a rectangle outline item to the overlay.</p>
|
<dd><p>Adds a rectangle outline item to the overlay.</p>
|
||||||
|
|
@ -762,7 +767,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.addFilledRect">
|
<dt id="map.addFilledRect">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">addFilledRect</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">width</em>, <em class="sig-param">height</em>, <em class="sig-param">color = "#000000"</em><span class="sig-paren">)</span><a class="headerlink" href="#map.addFilledRect" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">addFilledRect</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">width</em>, <em class="sig-param">height</em>, <em class="sig-param">color = "#000000"</em><span class="sig-paren">)</span><a class="headerlink" href="#map.addFilledRect" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Adds a filled rectangle item to the overlay.</p>
|
<dd><p>Adds a filled rectangle item to the overlay.</p>
|
||||||
|
|
@ -779,7 +784,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.addImage">
|
<dt id="map.addImage">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">addImage</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">filepath</em><span class="sig-paren">)</span><a class="headerlink" href="#map.addImage" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">addImage</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">filepath</em><span class="sig-paren">)</span><a class="headerlink" href="#map.addImage" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Adds an image item to the overlay.</p>
|
<dd><p>Adds an image item to the overlay.</p>
|
||||||
|
|
@ -798,7 +803,7 @@
|
||||||
<div class="section" id="tileset-functions">
|
<div class="section" id="tileset-functions">
|
||||||
<h4>Tileset Functions<a class="headerlink" href="#tileset-functions" title="Permalink to this headline">¶</a></h4>
|
<h4>Tileset Functions<a class="headerlink" href="#tileset-functions" title="Permalink to this headline">¶</a></h4>
|
||||||
<p>The following functions are related to tilesets and their palettes. The functions with “preview” in their name operate on a “fake” version of the palette colors. This means that changing these “preview” colors won’t affect the actual tileset colors in the project. A good use of the “preview” palettes would be Day/Night tints, for example.</p>
|
<p>The following functions are related to tilesets and their palettes. The functions with “preview” in their name operate on a “fake” version of the palette colors. This means that changing these “preview” colors won’t affect the actual tileset colors in the project. A good use of the “preview” palettes would be Day/Night tints, for example.</p>
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getPrimaryTilesetPalettePreview">
|
<dt id="map.getPrimaryTilesetPalettePreview">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getPrimaryTilesetPalettePreview</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getPrimaryTilesetPalettePreview" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getPrimaryTilesetPalettePreview</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getPrimaryTilesetPalettePreview" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets a palette from the primary tileset of the currently-opened map.</p>
|
<dd><p>Gets a palette from the primary tileset of the currently-opened map.</p>
|
||||||
|
|
@ -814,7 +819,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setPrimaryTilesetPalettePreview">
|
<dt id="map.setPrimaryTilesetPalettePreview">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setPrimaryTilesetPalettePreview</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em>, <em class="sig-param">colors</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setPrimaryTilesetPalettePreview" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setPrimaryTilesetPalettePreview</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em>, <em class="sig-param">colors</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setPrimaryTilesetPalettePreview" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets a palette in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.</p>
|
<dd><p>Sets a palette in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.</p>
|
||||||
|
|
@ -828,7 +833,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getPrimaryTilesetPalettesPreview">
|
<dt id="map.getPrimaryTilesetPalettesPreview">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getPrimaryTilesetPalettesPreview</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getPrimaryTilesetPalettesPreview" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getPrimaryTilesetPalettesPreview</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getPrimaryTilesetPalettesPreview" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets all of the palettes from the primary tileset of the currently-opened map.</p>
|
<dd><p>Gets all of the palettes from the primary tileset of the currently-opened map.</p>
|
||||||
|
|
@ -839,7 +844,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setPrimaryTilesetPalettesPreview">
|
<dt id="map.setPrimaryTilesetPalettesPreview">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setPrimaryTilesetPalettesPreview</code><span class="sig-paren">(</span><em class="sig-param">palettes</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setPrimaryTilesetPalettesPreview" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setPrimaryTilesetPalettesPreview</code><span class="sig-paren">(</span><em class="sig-param">palettes</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setPrimaryTilesetPalettesPreview" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets all of the palettes in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.</p>
|
<dd><p>Sets all of the palettes in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.</p>
|
||||||
|
|
@ -852,7 +857,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getSecondaryTilesetPalettePreview">
|
<dt id="map.getSecondaryTilesetPalettePreview">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getSecondaryTilesetPalettePreview</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getSecondaryTilesetPalettePreview" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getSecondaryTilesetPalettePreview</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getSecondaryTilesetPalettePreview" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets a palette from the secondary tileset of the currently-opened map.</p>
|
<dd><p>Gets a palette from the secondary tileset of the currently-opened map.</p>
|
||||||
|
|
@ -868,7 +873,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setSecondaryTilesetPalettePreview">
|
<dt id="map.setSecondaryTilesetPalettePreview">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setSecondaryTilesetPalettePreview</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em>, <em class="sig-param">colors</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setSecondaryTilesetPalettePreview" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setSecondaryTilesetPalettePreview</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em>, <em class="sig-param">colors</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setSecondaryTilesetPalettePreview" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets a palette in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.</p>
|
<dd><p>Sets a palette in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.</p>
|
||||||
|
|
@ -882,7 +887,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getSecondaryTilesetPalettesPreview">
|
<dt id="map.getSecondaryTilesetPalettesPreview">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getSecondaryTilesetPalettesPreview</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getSecondaryTilesetPalettesPreview" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getSecondaryTilesetPalettesPreview</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getSecondaryTilesetPalettesPreview" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets all of the palettes from the secondary tileset of the currently-opened map.</p>
|
<dd><p>Gets all of the palettes from the secondary tileset of the currently-opened map.</p>
|
||||||
|
|
@ -893,7 +898,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setSecondaryTilesetPalettesPreview">
|
<dt id="map.setSecondaryTilesetPalettesPreview">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setSecondaryTilesetPalettesPreview</code><span class="sig-paren">(</span><em class="sig-param">palettes</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setSecondaryTilesetPalettesPreview" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setSecondaryTilesetPalettesPreview</code><span class="sig-paren">(</span><em class="sig-param">palettes</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setSecondaryTilesetPalettesPreview" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets all of the palettes in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.</p>
|
<dd><p>Sets all of the palettes in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.</p>
|
||||||
|
|
@ -906,7 +911,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getPrimaryTilesetPalette">
|
<dt id="map.getPrimaryTilesetPalette">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getPrimaryTilesetPalette</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getPrimaryTilesetPalette" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getPrimaryTilesetPalette</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getPrimaryTilesetPalette" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets a palette from the primary tileset of the currently-opened map.</p>
|
<dd><p>Gets a palette from the primary tileset of the currently-opened map.</p>
|
||||||
|
|
@ -922,7 +927,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setPrimaryTilesetPalette">
|
<dt id="map.setPrimaryTilesetPalette">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setPrimaryTilesetPalette</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em>, <em class="sig-param">colors</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setPrimaryTilesetPalette" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setPrimaryTilesetPalette</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em>, <em class="sig-param">colors</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setPrimaryTilesetPalette" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets a palette in the primary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.</p>
|
<dd><p>Sets a palette in the primary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.</p>
|
||||||
|
|
@ -936,7 +941,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getPrimaryTilesetPalettes">
|
<dt id="map.getPrimaryTilesetPalettes">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getPrimaryTilesetPalettes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getPrimaryTilesetPalettes" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getPrimaryTilesetPalettes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getPrimaryTilesetPalettes" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets all of the palettes from the primary tileset of the currently-opened map.</p>
|
<dd><p>Gets all of the palettes from the primary tileset of the currently-opened map.</p>
|
||||||
|
|
@ -947,7 +952,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setPrimaryTilesetPalettes">
|
<dt id="map.setPrimaryTilesetPalettes">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setPrimaryTilesetPalettes</code><span class="sig-paren">(</span><em class="sig-param">palettes</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setPrimaryTilesetPalettes" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setPrimaryTilesetPalettes</code><span class="sig-paren">(</span><em class="sig-param">palettes</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setPrimaryTilesetPalettes" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets all of the palettes in the primary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.</p>
|
<dd><p>Sets all of the palettes in the primary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.</p>
|
||||||
|
|
@ -960,7 +965,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getSecondaryTilesetPalette">
|
<dt id="map.getSecondaryTilesetPalette">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getSecondaryTilesetPalette</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getSecondaryTilesetPalette" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getSecondaryTilesetPalette</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em><span class="sig-paren">)</span><a class="headerlink" href="#map.getSecondaryTilesetPalette" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets a palette from the secondary tileset of the currently-opened map.</p>
|
<dd><p>Gets a palette from the secondary tileset of the currently-opened map.</p>
|
||||||
|
|
@ -976,7 +981,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setSecondaryTilesetPalette">
|
<dt id="map.setSecondaryTilesetPalette">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setSecondaryTilesetPalette</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em>, <em class="sig-param">colors</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setSecondaryTilesetPalette" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setSecondaryTilesetPalette</code><span class="sig-paren">(</span><em class="sig-param">paletteIndex</em>, <em class="sig-param">colors</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setSecondaryTilesetPalette" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets a palette in the secondary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.</p>
|
<dd><p>Sets a palette in the secondary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.</p>
|
||||||
|
|
@ -990,7 +995,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getSecondaryTilesetPalettes">
|
<dt id="map.getSecondaryTilesetPalettes">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getSecondaryTilesetPalettes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getSecondaryTilesetPalettes" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getSecondaryTilesetPalettes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getSecondaryTilesetPalettes" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets all of the palettes from the secondary tileset of the currently-opened map.</p>
|
<dd><p>Gets all of the palettes from the secondary tileset of the currently-opened map.</p>
|
||||||
|
|
@ -1001,7 +1006,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setSecondaryTilesetPalettes">
|
<dt id="map.setSecondaryTilesetPalettes">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setSecondaryTilesetPalettes</code><span class="sig-paren">(</span><em class="sig-param">palettes</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setSecondaryTilesetPalettes" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setSecondaryTilesetPalettes</code><span class="sig-paren">(</span><em class="sig-param">palettes</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setSecondaryTilesetPalettes" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets all of the palettes in the secondary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.</p>
|
<dd><p>Sets all of the palettes in the secondary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.</p>
|
||||||
|
|
@ -1014,7 +1019,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getPrimaryTileset">
|
<dt id="map.getPrimaryTileset">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getPrimaryTileset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getPrimaryTileset" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getPrimaryTileset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getPrimaryTileset" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets the name of the primary tileset for the currently-opened map.</p>
|
<dd><p>Gets the name of the primary tileset for the currently-opened map.</p>
|
||||||
|
|
@ -1025,7 +1030,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setPrimaryTileset">
|
<dt id="map.setPrimaryTileset">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setPrimaryTileset</code><span class="sig-paren">(</span><em class="sig-param">tileset</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setPrimaryTileset" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setPrimaryTileset</code><span class="sig-paren">(</span><em class="sig-param">tileset</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setPrimaryTileset" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets the primary tileset for the currently-opened map.</p>
|
<dd><p>Sets the primary tileset for the currently-opened map.</p>
|
||||||
|
|
@ -1038,7 +1043,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getSecondaryTileset">
|
<dt id="map.getSecondaryTileset">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getSecondaryTileset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getSecondaryTileset" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getSecondaryTileset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getSecondaryTileset" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets the name of the secondary tileset for the currently-opened map.</p>
|
<dd><p>Gets the name of the secondary tileset for the currently-opened map.</p>
|
||||||
|
|
@ -1049,7 +1054,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setSecondaryTileset">
|
<dt id="map.setSecondaryTileset">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setSecondaryTileset</code><span class="sig-paren">(</span><em class="sig-param">tileset</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setSecondaryTileset" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setSecondaryTileset</code><span class="sig-paren">(</span><em class="sig-param">tileset</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setSecondaryTileset" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets the secondary tileset for the currently-opened map.</p>
|
<dd><p>Sets the secondary tileset for the currently-opened map.</p>
|
||||||
|
|
@ -1066,7 +1071,7 @@
|
||||||
<div class="section" id="settings-functions">
|
<div class="section" id="settings-functions">
|
||||||
<h4>Settings Functions<a class="headerlink" href="#settings-functions" title="Permalink to this headline">¶</a></h4>
|
<h4>Settings Functions<a class="headerlink" href="#settings-functions" title="Permalink to this headline">¶</a></h4>
|
||||||
<p>The following functions are related to settings.</p>
|
<p>The following functions are related to settings.</p>
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getGridVisibility">
|
<dt id="map.getGridVisibility">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getGridVisibility</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getGridVisibility" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getGridVisibility</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getGridVisibility" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets the visibility of the map grid overlay.</p>
|
<dd><p>Gets the visibility of the map grid overlay.</p>
|
||||||
|
|
@ -1077,7 +1082,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setGridVisibility">
|
<dt id="map.setGridVisibility">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setGridVisibility</code><span class="sig-paren">(</span><em class="sig-param">visible</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setGridVisibility" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setGridVisibility</code><span class="sig-paren">(</span><em class="sig-param">visible</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setGridVisibility" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets the visibility of the map grid overlay.</p>
|
<dd><p>Sets the visibility of the map grid overlay.</p>
|
||||||
|
|
@ -1090,7 +1095,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getBorderVisibility">
|
<dt id="map.getBorderVisibility">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getBorderVisibility</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getBorderVisibility" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getBorderVisibility</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getBorderVisibility" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets the visibility of the map’s border.</p>
|
<dd><p>Gets the visibility of the map’s border.</p>
|
||||||
|
|
@ -1101,7 +1106,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setBorderVisibility">
|
<dt id="map.setBorderVisibility">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setBorderVisibility</code><span class="sig-paren">(</span><em class="sig-param">visible</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setBorderVisibility" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setBorderVisibility</code><span class="sig-paren">(</span><em class="sig-param">visible</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setBorderVisibility" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets the visibility of the map’s border.</p>
|
<dd><p>Sets the visibility of the map’s border.</p>
|
||||||
|
|
@ -1114,7 +1119,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.getSmartPathsEnabled">
|
<dt id="map.getSmartPathsEnabled">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getSmartPathsEnabled</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getSmartPathsEnabled" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">getSmartPathsEnabled</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#map.getSmartPathsEnabled" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Gets the toggle state of smart paths.</p>
|
<dd><p>Gets the toggle state of smart paths.</p>
|
||||||
|
|
@ -1125,7 +1130,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setSmartPathsEnabled">
|
<dt id="map.setSmartPathsEnabled">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setSmartPathsEnabled</code><span class="sig-paren">(</span><em class="sig-param">enabled</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setSmartPathsEnabled" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setSmartPathsEnabled</code><span class="sig-paren">(</span><em class="sig-param">enabled</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setSmartPathsEnabled" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Sets the toggle state of smart paths.</p>
|
<dd><p>Sets the toggle state of smart paths.</p>
|
||||||
|
|
@ -1142,7 +1147,7 @@
|
||||||
<div class="section" id="utility-functions">
|
<div class="section" id="utility-functions">
|
||||||
<h4>Utility Functions<a class="headerlink" href="#utility-functions" title="Permalink to this headline">¶</a></h4>
|
<h4>Utility Functions<a class="headerlink" href="#utility-functions" title="Permalink to this headline">¶</a></h4>
|
||||||
<p>These are some miscellaneous functions that can be very useful when building custom scripts.</p>
|
<p>These are some miscellaneous functions that can be very useful when building custom scripts.</p>
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.registerAction">
|
<dt id="map.registerAction">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">registerAction</code><span class="sig-paren">(</span><em class="sig-param">functionName</em>, <em class="sig-param">actionName</em>, <em class="sig-param">shortcut = ""</em><span class="sig-paren">)</span><a class="headerlink" href="#map.registerAction" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">registerAction</code><span class="sig-paren">(</span><em class="sig-param">functionName</em>, <em class="sig-param">actionName</em>, <em class="sig-param">shortcut = ""</em><span class="sig-paren">)</span><a class="headerlink" href="#map.registerAction" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Registers a JavaScript function to an action that can be manually triggered in Porymap’s <code class="docutils literal notranslate"><span class="pre">Tools</span></code> menu. Optionally, a keyboard shortcut (e.g. <code class="docutils literal notranslate"><span class="pre">"Ctrl+P"</span></code>) can also be specified, assuming it doesn’t collide with any existing shortcuts used by Porymap.</p>
|
<dd><p>Registers a JavaScript function to an action that can be manually triggered in Porymap’s <code class="docutils literal notranslate"><span class="pre">Tools</span></code> menu. Optionally, a keyboard shortcut (e.g. <code class="docutils literal notranslate"><span class="pre">"Ctrl+P"</span></code>) can also be specified, assuming it doesn’t collide with any existing shortcuts used by Porymap.</p>
|
||||||
|
|
@ -1157,7 +1162,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.setTimeout">
|
<dt id="map.setTimeout">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setTimeout</code><span class="sig-paren">(</span><em class="sig-param">func</em>, <em class="sig-param">delayMs</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setTimeout" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">setTimeout</code><span class="sig-paren">(</span><em class="sig-param">func</em>, <em class="sig-param">delayMs</em><span class="sig-paren">)</span><a class="headerlink" href="#map.setTimeout" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>This behaves essentially the same as JavaScript’s <code class="docutils literal notranslate"><span class="pre">setTimeout()</span></code> that is used in web browsers or NodeJS. The <code class="docutils literal notranslate"><span class="pre">func</span></code> argument is a JavaScript function (NOT the name of a function) which will be executed after a delay. This is useful for creating animations or refreshing the overlay at constant intervals.</p>
|
<dd><p>This behaves essentially the same as JavaScript’s <code class="docutils literal notranslate"><span class="pre">setTimeout()</span></code> that is used in web browsers or NodeJS. The <code class="docutils literal notranslate"><span class="pre">func</span></code> argument is a JavaScript function (NOT the name of a function) which will be executed after a delay. This is useful for creating animations or refreshing the overlay at constant intervals.</p>
|
||||||
|
|
@ -1171,7 +1176,7 @@
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="js function">
|
||||||
<dt id="map.log">
|
<dt id="map.log">
|
||||||
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">log</code><span class="sig-paren">(</span><em class="sig-param">message</em><span class="sig-paren">)</span><a class="headerlink" href="#map.log" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-prename descclassname">map.</code><code class="sig-name descname">log</code><span class="sig-paren">(</span><em class="sig-param">message</em><span class="sig-paren">)</span><a class="headerlink" href="#map.log" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Logs a message to the Porymap log file. This is useful for debugging custom scripts.</p>
|
<dd><p>Logs a message to the Porymap log file. This is useful for debugging custom scripts.</p>
|
||||||
|
|
|
||||||
BIN
docs/objects.inv
BIN
docs/objects.inv
Binary file not shown.
|
|
@ -123,6 +123,7 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -139,6 +140,10 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../manual/creating-new-maps.html">Creating New Maps</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../manual/creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="../manual/region-map-editor.html">The Region Map Editor</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="../manual/region-map-editor.html">The Region Map Editor</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
|
||||||
|
|
@ -122,6 +122,7 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -138,6 +139,10 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../manual/creating-new-maps.html">Creating New Maps</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../manual/creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="../manual/region-map-editor.html">The Region Map Editor</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="../manual/region-map-editor.html">The Region Map Editor</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
|
||||||
|
|
@ -122,6 +122,7 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
@ -138,6 +139,10 @@
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="manual/creating-new-maps.html">Creating New Maps</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="manual/creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="manual/region-map-editor.html">The Region Map Editor</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="manual/region-map-editor.html">The Region Map Editor</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||||
|
|
|
||||||
File diff suppressed because one or more lines are too long
|
|
@ -45,8 +45,11 @@ templates_path = ['_templates']
|
||||||
# You can specify multiple suffix as a list of string:
|
# You can specify multiple suffix as a list of string:
|
||||||
#
|
#
|
||||||
|
|
||||||
from recommonmark.parser import CommonMarkParser
|
# sphinx >= 1.4
|
||||||
|
extensions = ['recommonmark']
|
||||||
|
|
||||||
|
# sphinx <= 1.3
|
||||||
|
from recommonmark.parser import CommonMarkParser
|
||||||
source_suffix = ['.rst', '.md']
|
source_suffix = ['.rst', '.md']
|
||||||
source_parsers = {
|
source_parsers = {
|
||||||
'.md': CommonMarkParser,
|
'.md': CommonMarkParser,
|
||||||
|
|
|
||||||
|
|
@ -16,6 +16,7 @@ Porymap Documentation
|
||||||
manual/editing-map-header
|
manual/editing-map-header
|
||||||
manual/editing-map-connections
|
manual/editing-map-connections
|
||||||
manual/editing-wild-encounters
|
manual/editing-wild-encounters
|
||||||
|
manual/creating-new-maps
|
||||||
manual/region-map-editor
|
manual/region-map-editor
|
||||||
manual/scripting-capabilities
|
manual/scripting-capabilities
|
||||||
manual/project-files
|
manual/project-files
|
||||||
|
|
|
||||||
73
docsrc/manual/creating-new-maps.rst
Normal file
73
docsrc/manual/creating-new-maps.rst
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
.. _creating-new-maps:
|
||||||
|
|
||||||
|
*****************
|
||||||
|
Creating New Maps
|
||||||
|
*****************
|
||||||
|
|
||||||
|
Creating a new map in porymap is easy! Just click *Tools -> New Map...*.
|
||||||
|
Alternatively, in any of the map list sort modes, you can right click on a folder
|
||||||
|
in order to add a new map to the folder.
|
||||||
|
|
||||||
|
For example, when sorting maps by their layout, you can add a new Pokemon Center from the existing layout.
|
||||||
|
|
||||||
|
.. figure:: images/creating-new-maps/right-click-layout-sort.png
|
||||||
|
:alt: Add New Map with Layout
|
||||||
|
|
||||||
|
Add New Map with Layout
|
||||||
|
|
||||||
|
New Map Options
|
||||||
|
---------------
|
||||||
|
|
||||||
|
The popup window when you create a new map will display some options in order to customize your new map.
|
||||||
|
|
||||||
|
.. figure:: images/creating-new-maps/new-map-options-window.png
|
||||||
|
:alt: New Map Options Window
|
||||||
|
|
||||||
|
New Map Options Window
|
||||||
|
|
||||||
|
The options you see may be different depending on your base project, but they are:
|
||||||
|
|
||||||
|
Name
|
||||||
|
The name of the new map. This cannot be changed in porymap.
|
||||||
|
|
||||||
|
Group
|
||||||
|
Which map group the new map will beling to. This cannot be changed in porymap.
|
||||||
|
|
||||||
|
Map Width
|
||||||
|
The width (in metatiles) of the map. This can be changed in porymap.
|
||||||
|
|
||||||
|
Map Height
|
||||||
|
The height (in metatiles) of the map. This can be changed in porymap.
|
||||||
|
|
||||||
|
Border Width
|
||||||
|
The width (in metatiles) of the map border blocks. This can be changed in porymap.
|
||||||
|
|
||||||
|
Border Height
|
||||||
|
The height (in metatiles) of the map border blocks. This can be changed in porymap.
|
||||||
|
|
||||||
|
Primary Tileset
|
||||||
|
The map's primary tileset. This can be changed in porymap.
|
||||||
|
|
||||||
|
Secondary Tileset
|
||||||
|
The map's secondary tileset. This can be changed in porymap.
|
||||||
|
|
||||||
|
Type
|
||||||
|
Whether this map is an indoor or outdoor map. This can be changed in porymap.
|
||||||
|
|
||||||
|
Location
|
||||||
|
The region map section this map exists in. This can be changed in porymap.
|
||||||
|
|
||||||
|
Can Fly To
|
||||||
|
Whether a heal location event will be created with this map. This cannot be changed in porymap.
|
||||||
|
|
||||||
|
Allow Running
|
||||||
|
Whether the player can sprint on this map. This can be changed in porymap.
|
||||||
|
|
||||||
|
Allow Biking
|
||||||
|
Whether the player can use the bike on this map. This can be changed in porymap.
|
||||||
|
|
||||||
|
Allow Escape Rope
|
||||||
|
Whether the user can escape from this map. This can be changed in porymap.
|
||||||
|
|
||||||
|
Floor Number
|
||||||
|
The floor number for this map if it is associated with an elevator. This can be changed in porymap.
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 400 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 109 KiB |
|
|
@ -25,6 +25,8 @@ Sort by Area
|
||||||
Sort by Layout
|
Sort by Layout
|
||||||
Organizes by map layouts. Most layouts are only used by a single map, but layouts like the Pokemon Center are used by many maps.
|
Organizes by map layouts. Most layouts are only used by a single map, but layouts like the Pokemon Center are used by many maps.
|
||||||
|
|
||||||
|
Right-clicking on the folder name in any of the sort modes will bring up a dialog to create a new map in that folder. For more details, see: :ref:`Creating New Maps <creating-new-maps>`.
|
||||||
|
|
||||||
The *Expand All* |expand-all-button| and *Collapse All* |collapse-all-button| buttons will expand or collapse all of the map folders.
|
The *Expand All* |expand-all-button| and *Collapse All* |collapse-all-button| buttons will expand or collapse all of the map folders.
|
||||||
|
|
||||||
Type in the filter to show maps that contain the filter text.
|
Type in the filter to show maps that contain the filter text.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue