Merge branch 'update-docs'
This commit is contained in:
Marcus Huderle
commit
7307c39561
80 changed files with 4346 additions and 11865 deletions
|
|
@ -1,4 +1,4 @@
|
|||
# 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.
|
||||
config: 0c9901306ee335472548e17d7ddc5dfb
|
||||
config: e41613e939dfe6ab7008de864b4e64a8
|
||||
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/porymap-scripting-grass.gif
Normal file
BIN
docs/_images/porymap-scripting-grass.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 243 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,7 +16,9 @@ Porymap Documentation
|
|||
manual/editing-map-header
|
||||
manual/editing-map-connections
|
||||
manual/editing-wild-encounters
|
||||
manual/creating-new-maps
|
||||
manual/region-map-editor
|
||||
manual/scripting-capabilities
|
||||
manual/project-files
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
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
|
||||
|
||||
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
|
||||
: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".
|
||||
|
||||
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
|
||||
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:
|
||||
|
||||
Warp Events
|
||||
|
|
@ -116,7 +119,7 @@ Var Value
|
|||
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
|
||||
:alt: Weather Trigger Event Properties
|
||||
|
|
@ -167,10 +170,17 @@ Item
|
|||
Flag
|
||||
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
|
||||
-----------------
|
||||
|
||||
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
|
||||
:alt: Secret Base Event Properties
|
||||
|
|
@ -183,6 +193,22 @@ Id
|
|||
Secret Base Id
|
||||
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
|
||||
------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ Weather
|
|||
The weather that is running when entering the map.
|
||||
|
||||
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
|
||||
Controls what graphics are used in battles.
|
||||
|
|
@ -36,8 +36,11 @@ Allow Running
|
|||
Allow Biking
|
||||
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.
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
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
|
||||
-------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Porymap reads and writes files in the decompilation projects. It **does not** r
|
|||
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:
|
||||
|
||||
|
|
|
|||
|
|
@ -25,6 +25,8 @@ Sort by Area
|
|||
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.
|
||||
|
||||
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.
|
||||
|
||||
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
|
||||
-----------------
|
||||
|
||||
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
|
||||
: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/metatiles.inc, yes, yes, also edits metatile files listed in this file
|
||||
src/data/wild_encounters.json, yes, yes,
|
||||
src/data/field_event_obj/event_object_graphics_info_pointers.h, yes, no,
|
||||
src/data/field_event_obj/event_object_graphics_info.h, yes, no,
|
||||
src/data/field_event_obj/event_object_pic_tables.h, yes, no,
|
||||
src/data/field_event_obj/event_object_graphics.h, yes, no,
|
||||
src/data/object_events/object_event_graphics_info_pointers.h, yes, no,
|
||||
src/data/object_events/object_event_graphics_info.h, yes, no,
|
||||
src/data/object_events/object_event_pic_tables.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/heal_locations.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/pokemon.h, yes, no, reads min and max level constants
|
||||
include/constants/map_types.h, yes, no,
|
||||
include/constants/secret_bases.h, yes, no,
|
||||
include/constants/event_object_movement_constants.h, yes, no,
|
||||
include/constants/bg_event_constants.h, yes, no,
|
||||
include/constants/trainer_types.h, yes, no,
|
||||
include/constants/secret_bases.h, yes, no, pokeemerald and pokeruby only
|
||||
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/metatile_labels.h, yes, yes,
|
||||
include/constants/metatile_behaviors.h, yes, no,
|
||||
include/constants/bg_event_constants.h, yes, no,
|
||||
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
|
||||
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:
|
||||
|
||||
.. figure:: images/region-map-editor/rme-new-window.png
|
||||
|
|
|
|||
551
docs/_sources/manual/scripting-capabilities.rst.txt
Normal file
551
docs/_sources/manual/scripting-capabilities.rst.txt
Normal file
|
|
@ -0,0 +1,551 @@
|
|||
**********************
|
||||
Scripting Capabilities
|
||||
**********************
|
||||
|
||||
Porymap is extensible via scripting capabilities. This allows the user to write custom JavaScript (technically, ECMAScript) files to support enhanced workflows, without having to fork Porymap itself. While the possibilities are endless, some useful examples of scripting might be:
|
||||
|
||||
- Toggle Day/Night Palettes
|
||||
- Custom Map Painting Brushes
|
||||
- Detect Tile Errors
|
||||
- Show Diagonistic Information
|
||||
- Procedurally Generated Maps
|
||||
- Randomize Grass Patterns
|
||||
|
||||
Writing a Custom Script
|
||||
-----------------------
|
||||
|
||||
Let's write a custom script that will randomize grass patterns when the user is editing the map. This is useful, since it's cumbersome to manually add randomness to grass patches. With the custom script, it will happen automatically. Whenever the user paints a grass tile onto the map, the script will overwrite the tile with a random grass tile instead.
|
||||
|
||||
First, create a new script file called ``my_script.js``--place it in the project directory (e.g. ``pokefirered/``).
|
||||
|
||||
Next, open the Porymap project config file, ``porymap.project.cfg``, in the project directory. Add the script file to the ``custom_scripts`` configuration value. Multiple script files can be loaded by separating the filepaths with a comma.
|
||||
|
||||
.. code-block::
|
||||
|
||||
custom_scripts=my_script.js
|
||||
|
||||
Now that Porymap is configured to load the script file, let's write the actual code that will power the grass-randomizer. Scripts have access to several "callbacks" for events that occur while Porymap is running. This means our script can define functions for each of these callbacks. We're interested in the ``onBlockChanged()`` callback, since we want our script to take action whenever a user paints a block on the map.
|
||||
|
||||
.. code-block:: js
|
||||
|
||||
// Porymap callback when a block is painted.
|
||||
export function onBlockChanged(x, y, prevBlock, newBlock) {
|
||||
// Grass-randomizing logic goes here.
|
||||
}
|
||||
|
||||
It's very **important** to remember to ``export`` the callback functions in the script. Otherwise, Porymap will not be able to execute them.
|
||||
|
||||
In addition to the callbacks, Porymap also supports a scripting API so that the script can interact with Porymap in interesting ways. For example, a script can change a block or add overlay text on the map. Since we want to paint random grass tiles, we'll be using the ``map.setMetatileId()`` function. Let's fill in the rest of the grass-randomizing code.
|
||||
|
||||
.. code-block:: js
|
||||
|
||||
function randInt(min, max) {
|
||||
min = Math.ceil(min);
|
||||
max = Math.floor(max);
|
||||
return Math.floor(Math.random() * (max - min)) + min;
|
||||
}
|
||||
|
||||
// These are the grass metatiles in pokefirered.
|
||||
const grassTiles = [0x8, 0x9, 0x10, 0x11];
|
||||
|
||||
// Porymap callback when a block is painted.
|
||||
export function onBlockChanged(x, y, prevBlock, newBlock) {
|
||||
// Check if the user is painting a grass tile.
|
||||
if (grassTiles.indexOf(newBlock.metatileId) != -1) {
|
||||
// Choose a random grass tile and paint it on the map.
|
||||
const i = randInt(0, grassTiles.length);
|
||||
map.setMetatileId(x, y, grassTiles[i]);
|
||||
}
|
||||
}
|
||||
|
||||
Let's test the script out by re-launching Porymap. If we try to paint grass on the map, we should see our script inserting a nice randomized grass pattern.
|
||||
|
||||
.. figure:: images/scripting-capabilities/porymap-scripting-grass.gif
|
||||
:alt: Grass-Randomizing Script
|
||||
|
||||
Grass-Randomizing Script
|
||||
|
||||
Registering Script Actions
|
||||
--------------------------
|
||||
|
||||
The grass-randomizer script above happens implicitly when the user paints on the map. However, other times we probably want to call the custom script on demand. One of the API functions Porymap provides is the ability to trigger scripting functions from the ``Tools`` menu, or a keyboard shortcut. To do this, we will usually want to register the action when the project loads. Here is an example script where some custom actions are registered.
|
||||
|
||||
.. code-block:: js
|
||||
|
||||
function applyNightTint() {
|
||||
// Apply night palette tinting...
|
||||
}
|
||||
|
||||
// Porymap callback when project is opened.
|
||||
export function onProjectOpened(projectPath) {
|
||||
map.registerAction("applyNightTint", "View Night Tint", "T")
|
||||
}
|
||||
|
||||
Then, to trigger the ``applyNightTint()`` function, we could either click ``Tools -> View Night Tint`` or use the ``T`` keyboard shortcut.
|
||||
|
||||
Now that we have an overview of how to utilize Porymap's scripting capabilities, the entire scripting API is documented below.
|
||||
|
||||
Scripting API
|
||||
-------------
|
||||
|
||||
Callbacks
|
||||
~~~~~~~~~
|
||||
|
||||
.. js:function:: onProjectOpened(projectPath)
|
||||
|
||||
Called when Porymap successfully opens a project.
|
||||
|
||||
:param string projectPath: the directory path of the opened project
|
||||
|
||||
.. js:function:: onProjectClosed(projectPath)
|
||||
|
||||
Called when Porymap closes a project. For example, this is called when opening a different project.
|
||||
|
||||
:param string projectPath: the directory path of the closed project
|
||||
|
||||
.. js:function:: onMapOpened(mapName)
|
||||
|
||||
Called when a map is opened.
|
||||
|
||||
:param string mapName: the name of the opened map
|
||||
|
||||
.. js:function:: onBlockChanged(x, y, prevBlock, newBlock)
|
||||
|
||||
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.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param object prevBlock: the block's state before it was modified. The object's shape is ``{metatileId, collision, elevation, rawValue}``
|
||||
:param object newBlock: the block's new state after it was modified. The object's shape is ``{metatileId, collision, elevation, rawValue}``
|
||||
|
||||
Functions
|
||||
~~~~~~~~~
|
||||
|
||||
All scripting functions are callable via the global ``map`` object.
|
||||
|
||||
Map Editing Functions
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following functions are related to editing the map's blocks or retrieving information about them.
|
||||
|
||||
.. js:function:: map.getBlock(x, y)
|
||||
|
||||
Gets a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns {metatileId, collision, elevation, rawValue}: the block object
|
||||
|
||||
.. js:function:: map.setBlock(x, y, metatileId, collision, elevation, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Sets a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number metatileId: the metatile id of the block
|
||||
:param number collision: the collision of the block (``0`` = passable, ``1`` = impassable)
|
||||
:param number elevation: the elevation of the block
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.getMetatileId(x, y)
|
||||
|
||||
Gets the metatile id of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns number: the metatile id of the block
|
||||
|
||||
.. js:function:: map.setMetatileId(x, y, metatileId, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Sets the metatile id of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number metatileId: the metatile id of the block
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.getCollision(x, y)
|
||||
|
||||
Gets the collision of a block in the currently-opened map. (``0`` = passable, ``1`` = impassable)
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns number: the collision of the block
|
||||
|
||||
.. js:function:: map.setCollision(x, y, collision, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Sets the collision of a block in the currently-opened map. (``0`` = passable, ``1`` = impassable)
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number collision: the collision of the block
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.getElevation(x, y)
|
||||
|
||||
Gets the elevation of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns number: the elevation of the block
|
||||
|
||||
.. js:function:: map.setElevation(x, y, elevation, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Sets the elevation of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number elevation: the elevation of the block
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.setBlocksFromSelection(x, y, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Sets blocks on the map using the user's current metatile selection.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.bucketFill(x, y, metatileId, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Performs a bucket fill of a metatile id, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param number metatileId: metatile id to fill
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.bucketFillFromSelection(x, y, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Performs a bucket fill using the user's current metatile selection, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.magicFill(x, y, metatileId, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Performs a magic fill of a metatile id, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param number metatileId: metatile id to magic fill
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.magicFillFromSelection(x, y, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Performs a magic fill using the user's current metatile selection, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.shift(xDelta, yDelta, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Performs a shift on the map's blocks.
|
||||
|
||||
:param number xDelta: number of blocks to shift horizontally
|
||||
:param number yDelta: number of blocks to shift vertically
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.getDimensions()
|
||||
|
||||
Gets the dimensions of the currently-opened map.
|
||||
|
||||
:returns {width, height}: the dimensions of the map
|
||||
|
||||
.. js:function:: map.getWidth()
|
||||
|
||||
Gets the width of the currently-opened map.
|
||||
|
||||
:returns number: the width of the map
|
||||
|
||||
.. js:function:: map.getHeight()
|
||||
|
||||
Gets the height of the currently-opened map.
|
||||
|
||||
:returns number: the height of the map
|
||||
|
||||
.. js:function:: map.setDimensions(width, height)
|
||||
|
||||
Sets the dimensions of the currently-opened map.
|
||||
|
||||
:param number width: width in blocks
|
||||
:param number height: height in blocks
|
||||
|
||||
.. js:function:: map.setWidth(width)
|
||||
|
||||
Sets the width of the currently-opened map.
|
||||
|
||||
:param number width: width in blocks
|
||||
|
||||
.. js:function:: map.setHeight()
|
||||
|
||||
Sets the height of the currently-opened map.
|
||||
|
||||
:param number height: height in blocks
|
||||
|
||||
.. js:function:: map.redraw()
|
||||
|
||||
Redraws the entire map area. Useful when delaying map redraws using ``forceRedraw = false`` in certain map editing functions.
|
||||
|
||||
.. js:function:: map.commit()
|
||||
|
||||
Commits any uncommitted changes to the map's edit/undo history. Useful when delaying commits using ``commitChanges = false`` in certain map editing functions.
|
||||
|
||||
Map Overlay Functions
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
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.
|
||||
|
||||
.. js:function:: map.clearOverlay()
|
||||
|
||||
Clears and erases all overlay items that were previously-added to the map.
|
||||
|
||||
.. js:function:: map.addText(text, x, y, color = "#000000", size = 12)
|
||||
|
||||
Adds a text item to the overlay.
|
||||
|
||||
:param string text: the text to display
|
||||
:param number x: the x pixel coordinate of the text
|
||||
:param number y: the y pixel coordinate of the text
|
||||
:param string color: the color of the text. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.
|
||||
:param number size: the font size of the text. Defaults to 12.
|
||||
|
||||
.. js:function:: map.addRect(x, y, width, height, color = "#000000")
|
||||
|
||||
Adds a rectangle outline item to the overlay.
|
||||
|
||||
:param number x: the x pixel coordinate of the rectangle's top-left corner
|
||||
:param number y: the y pixel coordinate of the rectangle's top-left corner
|
||||
:param number width: the pixel width of the rectangle
|
||||
:param number height: the pixel height of the rectangle
|
||||
:param string color: the color of the rectangle. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.
|
||||
|
||||
.. js:function:: map.addFilledRect(x, y, width, height, color = "#000000")
|
||||
|
||||
Adds a filled rectangle item to the overlay.
|
||||
|
||||
:param number x: the x pixel coordinate of the rectangle's top-left corner
|
||||
:param number y: the y pixel coordinate of the rectangle's top-left corner
|
||||
:param number width: the pixel width of the rectangle
|
||||
:param number height: the pixel height of the rectangle
|
||||
:param string color: the color of the rectangle. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.
|
||||
|
||||
.. js:function:: map.addImage(x, y, filepath)
|
||||
|
||||
Adds an image item to the overlay.
|
||||
|
||||
:param number x: the x pixel coordinate of the image's top-left corner
|
||||
:param number y: the y pixel coordinate of the image's top-left corner
|
||||
:param string filepath: the image's filepath
|
||||
|
||||
Tileset Functions
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
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.
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalettePreview(paletteIndex)
|
||||
|
||||
Gets a palette from the primary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalettePreview(paletteIndex, colors)
|
||||
|
||||
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.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalettesPreview()
|
||||
|
||||
Gets all of the palettes from the primary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalettesPreview(palettes)
|
||||
|
||||
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.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalettePreview(paletteIndex)
|
||||
|
||||
Gets a palette from the secondary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalettePreview(paletteIndex, colors)
|
||||
|
||||
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.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalettesPreview()
|
||||
|
||||
Gets all of the palettes from the secondary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalettesPreview(palettes)
|
||||
|
||||
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.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalette(paletteIndex)
|
||||
|
||||
Gets a palette from the primary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalette(paletteIndex, colors)
|
||||
|
||||
Sets a palette in the primary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalettes()
|
||||
|
||||
Gets all of the palettes from the primary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalettes(palettes)
|
||||
|
||||
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.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalette(paletteIndex)
|
||||
|
||||
Gets a palette from the secondary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalette(paletteIndex, colors)
|
||||
|
||||
Sets a palette in the secondary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalettes()
|
||||
|
||||
Gets all of the palettes from the secondary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalettes(palettes)
|
||||
|
||||
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.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTileset()
|
||||
|
||||
Gets the name of the primary tileset for the currently-opened map.
|
||||
|
||||
:returns string: primary tileset name
|
||||
|
||||
.. js:function:: map.setPrimaryTileset(tileset)
|
||||
|
||||
Sets the primary tileset for the currently-opened map.
|
||||
|
||||
:param string tileset: the tileset name
|
||||
|
||||
.. js:function:: map.getSecondaryTileset()
|
||||
|
||||
Gets the name of the secondary tileset for the currently-opened map.
|
||||
|
||||
:returns string: secondary tileset name
|
||||
|
||||
.. js:function:: map.setSecondaryTileset(tileset)
|
||||
|
||||
Sets the secondary tileset for the currently-opened map.
|
||||
|
||||
:param string tileset: the tileset name
|
||||
|
||||
Settings Functions
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following functions are related to settings.
|
||||
|
||||
.. js:function:: map.getGridVisibility()
|
||||
|
||||
Gets the visibility of the map grid overlay.
|
||||
|
||||
:returns boolean: grid visibility
|
||||
|
||||
.. js:function:: map.setGridVisibility(visible)
|
||||
|
||||
Sets the visibility of the map grid overlay.
|
||||
|
||||
:param boolean visible: grid visibility
|
||||
|
||||
.. js:function:: map.getBorderVisibility()
|
||||
|
||||
Gets the visibility of the map's border.
|
||||
|
||||
:returns boolean: border visibility
|
||||
|
||||
.. js:function:: map.setBorderVisibility(visible)
|
||||
|
||||
Sets the visibility of the map's border.
|
||||
|
||||
:param boolean visible: border visibility
|
||||
|
||||
.. js:function:: map.getSmartPathsEnabled()
|
||||
|
||||
Gets the toggle state of smart paths.
|
||||
|
||||
:returns boolean: smart paths enabled
|
||||
|
||||
.. js:function:: map.setSmartPathsEnabled(enabled)
|
||||
|
||||
Sets the toggle state of smart paths.
|
||||
|
||||
:param boolean enabled: smart paths enabled
|
||||
|
||||
Utility Functions
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
These are some miscellaneous functions that can be very useful when building custom scripts.
|
||||
|
||||
.. js:function:: map.registerAction(functionName, actionName, shortcut = "")
|
||||
|
||||
Registers a JavaScript function to an action that can be manually triggered in Porymap's ``Tools`` menu. Optionally, a keyboard shortcut (e.g. ``"Ctrl+P"``) can also be specified, assuming it doesn't collide with any existing shortcuts used by Porymap.
|
||||
|
||||
:param string functionName: name of the JavaScript function
|
||||
:param string actionName: name of the action that will be displayed in the ``Tools`` menu
|
||||
:param string shortcut: optional keyboard shortcut
|
||||
|
||||
.. js:function:: map.setTimeout(func, delayMs)
|
||||
|
||||
This behaves essentially the same as JavaScript's ``setTimeout()`` that is used in web browsers or NodeJS. The ``func`` 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.
|
||||
|
||||
:param function func: a JavaScript function that will be executed later
|
||||
:param number delayMs: the number of milliseconds to wait before executing ``func``
|
||||
|
||||
.. js:function:: map.log(message)
|
||||
|
||||
Logs a message to the Porymap log file. This is useful for debugging custom scripts.
|
||||
|
||||
:param string message: the message to log
|
||||
|
|
@ -2,12 +2,43 @@
|
|||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project somewhat adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). The MINOR version number is bumped when there are breaking changes in the pret projects.
|
||||
and this project somewhat adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). The MAJOR version number is bumped when there are breaking changes in the pret projects.
|
||||
|
||||
The **"Breaking Changes"** listed below are changes that have been made in the decompilation projects (e.g. pokeemerald), which porymap requires in order to work properly. If porymap is used on a project that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.
|
||||
|
||||
## Unreleased
|
||||
Nothing, yet.
|
||||
## [Unreleased]
|
||||
### Added
|
||||
- Add scripting capabilities, which allows the user to add custom behavior to Porymap using JavaScript scripts.
|
||||
- Add ability to import FRLG tileset .bvd files from Advance Map 1.92.
|
||||
|
||||
### Fixed
|
||||
- Disallow drawing new heal locations in the events tab.
|
||||
- Fix issue where the metatile selection window was not resizable.
|
||||
|
||||
## [4.0.0] - 2020-04-28
|
||||
### Breaking Changes
|
||||
- If you are using pokeemerald or pokeruby, there were changes made in [pokeemerald/#1010](https://github.com/pret/pokeemerald/pull/1010) and [pokeruby/#776](https://github.com/pret/pokeruby/pull/776) that you will need to integrate in order to use this version of porymap.
|
||||
|
||||
### Added
|
||||
- Support for [pokefirered](https://github.com/pret/pokefirered). Kanto fans rejoice! At long last porymap supports the FRLG decompilation project.
|
||||
- Add ability to export map stitches with `File -> Export Map Stitch Image...`.
|
||||
- Add new project config option `use_custom_border_size`.
|
||||
- Add ability to toggle project settings in `Options` menu.
|
||||
- Add file monitoring, so Porymap will prompt the user to reload the project if certain project files are modified outside of Porymap.
|
||||
- Add ability to reload project.
|
||||
- Add `Pencil`, `Move`, and `Map Shift` tools to the Events tab.
|
||||
|
||||
### Changed
|
||||
- Porymap now saves map and encounter json data in an order consistent with the upstream repos. This will provide more comprehensible diffs when files are saved.
|
||||
- Update Porymap icon.
|
||||
- The "Map" and "Events" tabs now render using the same view, so jumping between them is smooth.
|
||||
- Extend connection min and max offsets to player's view boundary, rather than the map's boundary.
|
||||
|
||||
### Fixed
|
||||
- Fix bug where pressing TAB key did not navigate through widgets in the wild encounter tables.
|
||||
- Fix bug that allowed selecting an invalid metatile in the metatile selector.
|
||||
- Don't allow `.` or `-` characters in new tileset names.
|
||||
- Fix regression that prevented selecting empty region map squares
|
||||
|
||||
## [3.0.1] - 2020-03-04
|
||||
### Fixed
|
||||
|
|
@ -150,7 +181,8 @@ Nothing, yet.
|
|||
## [1.0.0] - 2018-10-26
|
||||
This was the initial release.
|
||||
|
||||
[Unreleased]: https://github.com/huderlem/porymap/compare/3.0.1...HEAD
|
||||
[Unreleased]: https://github.com/huderlem/porymap/compare/4.0.0...HEAD
|
||||
[4.0.0]: https://github.com/huderlem/porymap/compare/3.0.1...4.0.0
|
||||
[3.0.1]: https://github.com/huderlem/porymap/compare/3.0.0...3.0.1
|
||||
[3.0.0]: https://github.com/huderlem/porymap/compare/2.0.0...3.0.0
|
||||
[2.0.0]: https://github.com/huderlem/porymap/compare/1.2.2...2.0.0
|
||||
|
|
|
|||
|
|
@ -1,3 +0,0 @@
|
|||
***********
|
||||
Changelog
|
||||
***********
|
||||
|
|
@ -1,3 +1,16 @@
|
|||
****************
|
||||
Related Projects
|
||||
****************
|
||||
****************
|
||||
|
||||
`Polished Map`_ - A map editor for pokecrystal, pokered, and other Gen 1/2 disassembly projects.
|
||||
|
||||
Poryscript_ - A high-level scripting language meant to be used with the decompilation projects.
|
||||
|
||||
`VG Music Studio`_ - A program that lets you listen to the music from popular video game formats.
|
||||
|
||||
`Tilemap Studio`_ - A tilemap editor for Game Boy, Color, and Advance projects.
|
||||
|
||||
.. _Polished Map: https://github.com/Rangi42/polished-map
|
||||
.. _Poryscript: https://github.com/huderlem/poryscript
|
||||
.. _VG Music Studio: https://github.com/Kermalis/VGMusicStudio
|
||||
.. _Tilemap Studio: https://github.com/Rangi42/tilemap-studio
|
||||
|
|
|
|||
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,
|
||||
BUILDER: 'html',
|
||||
FILE_SUFFIX: '.html',
|
||||
LINK_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt',
|
||||
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 listItem = $('<li style="display:none"></li>');
|
||||
var requestUrl = "";
|
||||
var linkUrl = "";
|
||||
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
|
||||
// dirhtml builder
|
||||
var dirname = item[0] + '/';
|
||||
|
|
@ -260,13 +261,15 @@ var Search = {
|
|||
dirname = '';
|
||||
}
|
||||
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
|
||||
linkUrl = requestUrl;
|
||||
|
||||
} else {
|
||||
// normal html builders
|
||||
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
|
||||
linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
|
||||
}
|
||||
listItem.append($('<a/>').attr('href',
|
||||
requestUrl +
|
||||
linkUrl +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
if (item[3]) {
|
||||
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#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#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#open-map-scripts">Open Map Scripts</a></li>
|
||||
</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>
|
||||
</ul>
|
||||
</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-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>
|
||||
|
|
@ -145,56 +150,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/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></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">3.0.1 - 2020-03-04</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#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<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#added">Added</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">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Fixed</a></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#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Fixed</a></li>
|
||||
<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#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Added</a></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.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id20">Fixed</a></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#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id25">Fixed</a></li>
|
||||
<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#id26">1.0.0 - 2018-10-26</a></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>
|
||||
|
|
@ -268,8 +301,146 @@
|
|||
<h1 id="index">Index</h1>
|
||||
|
||||
<div class="genindex-jumpbox">
|
||||
<a href="#M"><strong>M</strong></a>
|
||||
| <a href="#O"><strong>O</strong></a>
|
||||
|
||||
</div>
|
||||
<h2 id="M">M</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="manual/scripting-capabilities.html#map.addFilledRect">map.addFilledRect() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.addImage">map.addImage() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.addRect">map.addRect() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.addText">map.addText() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.bucketFill">map.bucketFill() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.bucketFillFromSelection">map.bucketFillFromSelection() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.clearOverlay">map.clearOverlay() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.commit">map.commit() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getBlock">map.getBlock() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getBorderVisibility">map.getBorderVisibility() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getCollision">map.getCollision() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getDimensions">map.getDimensions() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getElevation">map.getElevation() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getGridVisibility">map.getGridVisibility() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getHeight">map.getHeight() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getMetatileId">map.getMetatileId() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getPrimaryTileset">map.getPrimaryTileset() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getPrimaryTilesetPalette">map.getPrimaryTilesetPalette() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getPrimaryTilesetPalettePreview">map.getPrimaryTilesetPalettePreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getPrimaryTilesetPalettes">map.getPrimaryTilesetPalettes() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getPrimaryTilesetPalettesPreview">map.getPrimaryTilesetPalettesPreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getSecondaryTileset">map.getSecondaryTileset() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getSecondaryTilesetPalette">map.getSecondaryTilesetPalette() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getSecondaryTilesetPalettePreview">map.getSecondaryTilesetPalettePreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getSecondaryTilesetPalettes">map.getSecondaryTilesetPalettes() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getSecondaryTilesetPalettesPreview">map.getSecondaryTilesetPalettesPreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getSmartPathsEnabled">map.getSmartPathsEnabled() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getWidth">map.getWidth() (map method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="manual/scripting-capabilities.html#map.log">map.log() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.magicFill">map.magicFill() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.magicFillFromSelection">map.magicFillFromSelection() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.redraw">map.redraw() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.registerAction">map.registerAction() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setBlock">map.setBlock() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setBlocksFromSelection">map.setBlocksFromSelection() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setBorderVisibility">map.setBorderVisibility() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setCollision">map.setCollision() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setDimensions">map.setDimensions() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setElevation">map.setElevation() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setGridVisibility">map.setGridVisibility() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setHeight">map.setHeight() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setMetatileId">map.setMetatileId() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setPrimaryTileset">map.setPrimaryTileset() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setPrimaryTilesetPalette">map.setPrimaryTilesetPalette() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setPrimaryTilesetPalettePreview">map.setPrimaryTilesetPalettePreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setPrimaryTilesetPalettes">map.setPrimaryTilesetPalettes() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setPrimaryTilesetPalettesPreview">map.setPrimaryTilesetPalettesPreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setSecondaryTileset">map.setSecondaryTileset() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setSecondaryTilesetPalette">map.setSecondaryTilesetPalette() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setSecondaryTilesetPalettePreview">map.setSecondaryTilesetPalettePreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setSecondaryTilesetPalettes">map.setSecondaryTilesetPalettes() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setSecondaryTilesetPalettesPreview">map.setSecondaryTilesetPalettesPreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setSmartPathsEnabled">map.setSmartPathsEnabled() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setTimeout">map.setTimeout() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setWidth">map.setWidth() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.shift">map.shift() (map method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="O">O</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="manual/scripting-capabilities.html#onBlockChanged">onBlockChanged() (built-in function)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#onMapOpened">onMapOpened() (built-in function)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="manual/scripting-capabilities.html#onProjectClosed">onProjectClosed() (built-in function)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#onProjectOpened">onProjectOpened() (built-in function)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
|
@ -282,7 +453,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
115
docs/index.html
115
docs/index.html
|
|
@ -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#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#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#open-map-scripts">Open Map Scripts</a></li>
|
||||
</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>
|
||||
</ul>
|
||||
</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-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>
|
||||
|
|
@ -145,56 +150,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/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></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">3.0.1 - 2020-03-04</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#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<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#added">Added</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">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Fixed</a></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#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Fixed</a></li>
|
||||
<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#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Added</a></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.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id20">Fixed</a></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#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id25">Fixed</a></li>
|
||||
<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#id26">1.0.0 - 2018-10-26</a></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>
|
||||
|
|
@ -313,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#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#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#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -329,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>
|
||||
</ul>
|
||||
</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-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>
|
||||
|
|
@ -336,6 +374,12 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#scripting-api">Scripting API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -344,14 +388,15 @@
|
|||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">3.0.1 - 2020-03-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">3.0.0 - 2020-03-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">2.0.0 - 2019-10-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id9">1.2.2 - 2019-05-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">1.2.1 - 2019-02-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.0 - 2019-02-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id21">1.1.0 - 2018-12-27</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">4.0.0 - 2020-04-28</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">3.0.1 - 2020-03-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id6">3.0.0 - 2020-03-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id11">2.0.0 - 2019-10-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.2 - 2019-05-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id20">1.2.1 - 2019-02-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id23">1.2.0 - 2019-02-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id28">1.1.0 - 2018-12-27</a></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>
|
||||
|
|
@ -377,7 +422,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
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#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>
|
||||
|
|
@ -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>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||
|
|
@ -146,56 +151,84 @@
|
|||
<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></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</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#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<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#added">Added</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">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></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#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<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#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></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.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></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#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<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#id26">1.0.0 - 2018-10-26</a></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>
|
||||
|
|
@ -334,7 +367,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</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#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>
|
||||
|
|
@ -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>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||
|
|
@ -146,56 +151,84 @@
|
|||
<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></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</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#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<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#added">Added</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">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></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#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<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#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></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.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></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#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<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#id26">1.0.0 - 2018-10-26</a></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>
|
||||
|
|
@ -308,7 +341,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -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="#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="#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="#open-map-scripts">Open Map Scripts</a></li>
|
||||
</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>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||
|
|
@ -146,56 +151,84 @@
|
|||
<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></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</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#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<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#added">Added</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">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></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#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<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#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></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.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></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#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<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#id26">1.0.0 - 2018-10-26</a></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>
|
||||
|
|
@ -272,7 +305,7 @@
|
|||
<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>
|
||||
</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">
|
||||
<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>
|
||||
|
|
@ -311,10 +344,12 @@
|
|||
</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>
|
||||
</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>
|
||||
<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>
|
||||
<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>
|
||||
</div>
|
||||
<div class="section" id="warp-events">
|
||||
|
|
@ -353,7 +388,7 @@
|
|||
</div>
|
||||
<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>
|
||||
<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">
|
||||
<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>
|
||||
|
|
@ -395,11 +430,16 @@
|
|||
</dd>
|
||||
<dt>Flag</dt><dd><p>This flag is set when the player receives the hidden item.</p>
|
||||
</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>
|
||||
</div>
|
||||
<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>
|
||||
<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">
|
||||
<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>
|
||||
|
|
@ -411,6 +451,20 @@
|
|||
</dd>
|
||||
</dl>
|
||||
</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">
|
||||
<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>
|
||||
|
|
@ -442,7 +496,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</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#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>
|
||||
|
|
@ -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>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||
|
|
@ -146,56 +151,84 @@
|
|||
<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></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</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#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<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#added">Added</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">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></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#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<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#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></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.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></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#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<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#id26">1.0.0 - 2018-10-26</a></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>
|
||||
|
|
@ -281,7 +314,7 @@
|
|||
</dd>
|
||||
<dt>Weather</dt><dd><p>The weather that is running when entering the map.</p>
|
||||
</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>
|
||||
<dt>Battle Scene</dt><dd><p>Controls what graphics are used in battles.</p>
|
||||
</dd>
|
||||
|
|
@ -291,7 +324,9 @@
|
|||
</dd>
|
||||
<dt>Allow Biking</dt><dd><p>Controls whether or not a bike can be used.</p>
|
||||
</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>
|
||||
<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>
|
||||
|
|
@ -318,7 +353,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</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#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>
|
||||
|
|
@ -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>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||
|
|
@ -146,56 +151,84 @@
|
|||
<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></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</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#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<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#added">Added</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">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></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#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<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#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></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.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></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#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<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#id26">1.0.0 - 2018-10-26</a></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>
|
||||
|
|
@ -361,6 +394,7 @@
|
|||
<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>
|
||||
</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 class="section" id="change-map-tilesets">
|
||||
<h2>Change Map Tilesets<a class="headerlink" href="#change-map-tilesets" title="Permalink to this headline">¶</a></h2>
|
||||
|
|
@ -396,7 +430,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@
|
|||
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="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" />
|
||||
</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#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>
|
||||
|
|
@ -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>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||
|
|
@ -146,56 +151,84 @@
|
|||
<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></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</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#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<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#added">Added</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">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></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#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<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#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></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.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></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#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<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#id26">1.0.0 - 2018-10-26</a></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>
|
||||
|
|
@ -357,7 +390,7 @@ the levels.</p>
|
|||
|
||||
<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>
|
||||
|
|
@ -369,7 +402,7 @@ the levels.</p>
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</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#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>
|
||||
|
|
@ -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>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||
|
|
@ -146,56 +151,84 @@
|
|||
<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></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</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#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<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#added">Added</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">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></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#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<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#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></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.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></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#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<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#id26">1.0.0 - 2018-10-26</a></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>
|
||||
|
|
@ -275,7 +308,7 @@
|
|||
</div>
|
||||
<div class="section" id="getting-started">
|
||||
<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>
|
||||
<div class="figure align-default" id="id1">
|
||||
<img alt="Porymap Empty Window" src="../_images/porymap-empty-window.png" />
|
||||
|
|
@ -339,7 +372,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</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#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>
|
||||
|
|
@ -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>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||
|
|
@ -146,56 +151,84 @@
|
|||
<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></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</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#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<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#added">Added</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">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></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#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<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#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></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.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></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#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<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#id26">1.0.0 - 2018-10-26</a></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>
|
||||
|
|
@ -284,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>
|
||||
</dd>
|
||||
</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>Type in the filter to show maps that contain the filter text.</p>
|
||||
<div class="figure align-default" id="id2">
|
||||
|
|
@ -321,7 +355,7 @@
|
|||
</div>
|
||||
<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>
|
||||
<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">
|
||||
<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>
|
||||
|
|
@ -350,7 +384,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@
|
|||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="Changelog" href="../reference/changelog.html" />
|
||||
<link rel="prev" title="The Region Map Editor" href="region-map-editor.html" />
|
||||
<link rel="prev" title="Scripting Capabilities" href="scripting-capabilities.html" />
|
||||
</head>
|
||||
|
||||
<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#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>
|
||||
|
|
@ -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>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||||
|
|
@ -146,56 +151,84 @@
|
|||
<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 current"><a class="current reference internal" href="#">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></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</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#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<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#added">Added</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">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></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#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<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#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></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.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></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#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<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#id26">1.0.0 - 2018-10-26</a></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>
|
||||
|
|
@ -325,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></td>
|
||||
</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>no</p></td>
|
||||
<td></td>
|
||||
</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>no</p></td>
|
||||
<td></td>
|
||||
</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>no</p></td>
|
||||
<td></td>
|
||||
</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>no</p></td>
|
||||
<td></td>
|
||||
|
|
@ -400,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></td>
|
||||
</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>no</p></td>
|
||||
<td></td>
|
||||
</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>no</p></td>
|
||||
<td></td>
|
||||
</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>no</p></td>
|
||||
<td></td>
|
||||
</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>no</p></td>
|
||||
<td></td>
|
||||
</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></td>
|
||||
</tr>
|
||||
<tr class="row-even"><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>
|
||||
<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>
|
||||
|
|
@ -455,7 +488,7 @@ to a file, it probably is not a good idea to edit yourself unless otherwise note
|
|||
<a href="../reference/changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="region-map-editor.html" class="btn btn-neutral float-left" title="The Region Map Editor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="scripting-capabilities.html" class="btn btn-neutral float-left" title="Scripting Capabilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
@ -464,7 +497,7 @@ to a file, it probably is not a good idea to edit yourself unless otherwise note
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -36,8 +36,8 @@
|
|||
<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="Project Files" href="project-files.html" />
|
||||
<link rel="prev" title="Editing Wild Encounters" href="editing-wild-encounters.html" />
|
||||
<link rel="next" title="Scripting Capabilities" href="scripting-capabilities.html" />
|
||||
<link rel="prev" title="Creating New Maps" href="creating-new-maps.html" />
|
||||
</head>
|
||||
|
||||
<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#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>
|
||||
|
|
@ -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>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="creating-new-maps.html#new-map-options">New Map Options</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 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="#map-layout-tab">Map Layout Tab</a></li>
|
||||
|
|
@ -146,56 +151,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="#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></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</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#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<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#added">Added</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">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></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#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<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#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></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.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></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#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<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#id26">1.0.0 - 2018-10-26</a></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>
|
||||
|
|
@ -269,6 +302,10 @@
|
|||
<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
|
||||
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>
|
||||
<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>
|
||||
|
|
@ -376,10 +413,10 @@ but that functionality will be added in a future update.</p>
|
|||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="project-files.html" class="btn btn-neutral float-right" title="Project Files" 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>
|
||||
|
||||
|
|
@ -388,7 +425,7 @@ but that functionality will be added in a future update.</p>
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
1278
docs/manual/scripting-capabilities.html
Normal file
1278
docs/manual/scripting-capabilities.html
Normal file
File diff suppressed because it is too large
Load diff
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#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#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#open-map-scripts">Open Map Scripts</a></li>
|
||||
</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>
|
||||
</ul>
|
||||
</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-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>
|
||||
|
|
@ -146,56 +151,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../manual/scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../manual/scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../manual/project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -269,25 +302,77 @@
|
|||
<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h1>
|
||||
<p>All notable changes to this project will be documented in this file.</p>
|
||||
<p>The format is based on <a class="reference external" href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>,
|
||||
and this project somewhat adheres to <a class="reference external" href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>. The MINOR version number is bumped when there are breaking changes in the pret projects.</p>
|
||||
and this project somewhat adheres to <a class="reference external" href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>. The MAJOR version number is bumped when there are breaking changes in the pret projects.</p>
|
||||
<p>The <strong>“Breaking Changes”</strong> listed below are changes that have been made in the decompilation projects (e.g. pokeemerald), which porymap requires in order to work properly. If porymap is used on a project that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.</p>
|
||||
<div class="section" id="unreleased">
|
||||
<h2>Unreleased<a class="headerlink" href="#unreleased" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Nothing, yet.</p>
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.0.0...HEAD">Unreleased</a><a class="headerlink" href="#unreleased" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="added">
|
||||
<h3>Added<a class="headerlink" href="#added" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add scripting capabilities, which allows the user to add custom behavior to Porymap using JavaScript scripts.</p></li>
|
||||
<li><p>Add ability to import FRLG tileset .bvd files from Advance Map 1.92.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id1">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/3.0.0...3.0.1">3.0.1</a> - 2020-03-04<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="fixed">
|
||||
<h3>Fixed<a class="headerlink" href="#fixed" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Disallow drawing new heal locations in the events tab.</p></li>
|
||||
<li><p>Fix issue where the metatile selection window was not resizable.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id1">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/3.0.1...4.0.0">4.0.0</a> - 2020-04-28<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="breaking-changes">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#breaking-changes" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>If you are using pokeemerald or pokeruby, there were changes made in <a class="reference external" href="https://github.com/pret/pokeemerald/pull/1010">pokeemerald/#1010</a> and <a class="reference external" href="https://github.com/pret/pokeruby/pull/776">pokeruby/#776</a> that you will need to integrate in order to use this version of porymap.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<h3>Added<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Support for <a class="reference external" href="https://github.com/pret/pokefirered">pokefirered</a>. Kanto fans rejoice! At long last porymap supports the FRLG decompilation project.</p></li>
|
||||
<li><p>Add ability to export map stitches with <code class="docutils literal notranslate"><span class="pre">File</span> <span class="pre">-></span> <span class="pre">Export</span> <span class="pre">Map</span> <span class="pre">Stitch</span> <span class="pre">Image...</span></code>.</p></li>
|
||||
<li><p>Add new project config option <code class="docutils literal notranslate"><span class="pre">use_custom_border_size</span></code>.</p></li>
|
||||
<li><p>Add ability to toggle project settings in <code class="docutils literal notranslate"><span class="pre">Options</span></code> menu.</p></li>
|
||||
<li><p>Add file monitoring, so Porymap will prompt the user to reload the project if certain project files are modified outside of Porymap.</p></li>
|
||||
<li><p>Add ability to reload project.</p></li>
|
||||
<li><p>Add <code class="docutils literal notranslate"><span class="pre">Pencil</span></code>, <code class="docutils literal notranslate"><span class="pre">Move</span></code>, and <code class="docutils literal notranslate"><span class="pre">Map</span> <span class="pre">Shift</span></code> tools to the Events tab.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="changed">
|
||||
<h3>Changed<a class="headerlink" href="#changed" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Porymap now saves map and encounter json data in an order consistent with the upstream repos. This will provide more comprehensible diffs when files are saved.</p></li>
|
||||
<li><p>Update Porymap icon.</p></li>
|
||||
<li><p>The “Map” and “Events” tabs now render using the same view, so jumping between them is smooth.</p></li>
|
||||
<li><p>Extend connection min and max offsets to player’s view boundary, rather than the map’s boundary.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id3">
|
||||
<h3>Fixed<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix bug where pressing TAB key did not navigate through widgets in the wild encounter tables.</p></li>
|
||||
<li><p>Fix bug that allowed selecting an invalid metatile in the metatile selector.</p></li>
|
||||
<li><p>Don’t allow <code class="docutils literal notranslate"><span class="pre">.</span></code> or <code class="docutils literal notranslate"><span class="pre">-</span></code> characters in new tileset names.</p></li>
|
||||
<li><p>Fix regression that prevented selecting empty region map squares</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/3.0.0...3.0.1">3.0.1</a> - 2020-03-04<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id5">
|
||||
<h3>Fixed<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix bug on Mac where tileset images were corrupted when saving.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/2.0.0...3.0.0">3.0.0</a> - 2020-03-04<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="breaking-changes">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#breaking-changes" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id6">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/2.0.0...3.0.0">3.0.0</a> - 2020-03-04<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id7">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>pokeemerald and pokeruby both underwent a naming consistency update with respect to “object events”. As such, these naming changes break old versions of Porymap.</p>
|
||||
<ul>
|
||||
|
|
@ -297,22 +382,22 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="added">
|
||||
<h3>Added<a class="headerlink" href="#added" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id8">
|
||||
<h3>Added<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add optional support for Poryscript script files via the <code class="docutils literal notranslate"><span class="pre">use_poryscript</span></code> config option.</p></li>
|
||||
<li><p>Selecting a group of metatiles from the map area now also copies the collision properties, too.</p></li>
|
||||
<li><p>Add keyboard shortcut <code class="docutils literal notranslate"><span class="pre">Ctrl</span> <span class="pre">+</span> <span class="pre">G</span></code> for toggling the map grid.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="changed">
|
||||
<h3>Changed<a class="headerlink" href="#changed" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id9">
|
||||
<h3>Changed<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Draw map connections with the current map’s tilesets to more accurately mimic their appearance in-game.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id3">
|
||||
<h3>Fixed<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id10">
|
||||
<h3>Fixed<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix index-out-of-bounds crash when deleting the last event in an event type group.</p></li>
|
||||
<li><p>Fix bug where exporting tileset images could add an extra row of junk at the end.</p></li>
|
||||
|
|
@ -322,17 +407,17 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.2...2.0.0">2.0.0</a> - 2019-10-16<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id5">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id11">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.2...2.0.0">2.0.0</a> - 2019-10-16<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id12">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Accomodate event object graphics pointer table being explicitly indexed. From changes introduced in commits <a class="reference external" href="https://github.com/pret/pokeemerald/commit/cdae0c1444bed98e652c87dc3e3edcecacfef8be">cdae0c1444bed98e652c87dc3e3edcecacfef8be</a> and <a class="reference external" href="https://github.com/pret/pokeruby/commit/0e8ccfc4fd3544001f4c25fafd401f7558bdefba">0e8ccfc4fd3544001f4c25fafd401f7558bdefba</a>.</p></li>
|
||||
<li><p>New “field” key in wild encounter JSON data from pokeemerald and pokeruby commits <a class="reference external" href="https://github.com/pret/pokeemerald/commit/adb0a444577b59eb02788c782a3d04bc285be0ba">adb0a444577b59eb02788c782a3d04bc285be0ba</a> and <a class="reference external" href="c73de8bed752ca538d90cfc93c4a9e8c7965f8c9">https://github.com/pret/pokeruby/commit/c73de8bed752ca538d90cfc93c4a9e8c7965f8c9</a>.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id6">
|
||||
<h3>Added<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id13">
|
||||
<h3>Added<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add wild encounter table editor.</p></li>
|
||||
<li><p>Add dark themes.</p></li>
|
||||
|
|
@ -340,16 +425,16 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
<li><p>Add warning when closing porymap with unsaved changes.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id7">
|
||||
<h3>Changed<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id14">
|
||||
<h3>Changed<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Exporting map images is now more configurable. Events, connections, collision, etc. can be toggled on and off before exporting the image.</p></li>
|
||||
<li><p>The entire Tileset Editor selection is now conveniently flipped when selecting x-flip or y-flip.</p></li>
|
||||
<li><p>Autocomplete for porymap’s comboboxes no longer require typing the full string prefix.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id8">
|
||||
<h3>Fixed<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id15">
|
||||
<h3>Fixed<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix bug where map group names were hardcoded when creating a new map.</p></li>
|
||||
<li><p>Fix bug in Tileset Editor where multi-tile selections weren’t properly painted when clicking on the bottom row of the metatile layers.</p></li>
|
||||
|
|
@ -360,18 +445,18 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id9">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.1...1.2.2">1.2.2</a> - 2019-05-16<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id10">
|
||||
<h3>Added<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id16">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.1...1.2.2">1.2.2</a> - 2019-05-16<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id17">
|
||||
<h3>Added<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add region map editor</p></li>
|
||||
<li><p>Add ability to add new tilesets</p></li>
|
||||
<li><p>Add official Porymap documentation website: https://huderlem.github.io/porymap/</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id11">
|
||||
<h3>Changed<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id18">
|
||||
<h3>Changed<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Event sprites now display as facing the direction of their movement type.</p></li>
|
||||
<li><p>Default values for newly-created events now use valid values from the project, rather than hardcoded values.</p></li>
|
||||
|
|
@ -381,8 +466,8 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
<li><p>Default values for new events are now more sensible and guaranteed to be valid.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id12">
|
||||
<h3>Fixed<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id19">
|
||||
<h3>Fixed<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix bug in zoomed metatile selector where a large selection rectangle was being rendered.</p></li>
|
||||
<li><p>Fix bug where edited map icons were not rendered properly.</p></li>
|
||||
|
|
@ -391,32 +476,32 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id13">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.0...1.2.1">1.2.1</a> - 2019-02-16<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id14">
|
||||
<h3>Added<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id20">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.0...1.2.1">1.2.1</a> - 2019-02-16<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id21">
|
||||
<h3>Added<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add ability to zoom in and out the map metatile selector via a slider at the bottom of the metatile selector window.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id15">
|
||||
<h3>Fixed<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id22">
|
||||
<h3>Fixed<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix crash when creating a new map from a layout that has no pre-existing maps that use it.</p></li>
|
||||
<li><p>Fix bug where <code class="docutils literal notranslate"><span class="pre">var_value</span></code>, <code class="docutils literal notranslate"><span class="pre">trainer_type</span></code> and <code class="docutils literal notranslate"><span class="pre">trainer_sight_or_berry_tree_id</span></code> JSON fields were being interpreted as integers.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id16">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.1.0...1.2.0">1.2.0</a> - 2019-02-04<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id17">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id23">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.1.0...1.2.0">1.2.0</a> - 2019-02-04<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id24">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>New JSON map data format in pokeemerald and pokeruby from commits <a class="reference external" href="https://github.com/pret/pokeemerald/commit/82abc164dc9f6a74fdf0c535cc1621b7ed05318b">82abc164dc9f6a74fdf0c535cc1621b7ed05318b</a> and <a class="reference external" href="https://github.com/pret/pokeruby/commit/a0ba1b7c6353f7e4f3066025514c05b323a0123d">a0ba1b7c6353f7e4f3066025514c05b323a0123d</a>.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id18">
|
||||
<h3>Added<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id25">
|
||||
<h3>Added<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add “magic fill” mode to fill tool (hold down CTRL key). This fills all matching metatiles on the map, rather than only the contiguous region.</p></li>
|
||||
<li><p>Add ability to import tileset palettes (JASC, .pal, .tpl, .gpl, .act).</p></li>
|
||||
|
|
@ -429,8 +514,8 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
<li><p>Add ability to define custom fields for map header and all events.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id19">
|
||||
<h3>Changed<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id26">
|
||||
<h3>Changed<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Collapse the map list by default.</p></li>
|
||||
<li><p>Collision view now has a transparency slider to help make it easier to view the underlying metatiles.</p></li>
|
||||
|
|
@ -444,8 +529,8 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
<li><p>The tiles image in the tileset editor will no longer flip according to the x/y flip checkboxes. The individual tile selection still flips, though.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id20">
|
||||
<h3>Fixed<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id27">
|
||||
<h3>Fixed<a class="headerlink" href="#id27" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix bug where smart paths could be auto-enabled, despite the checkbox being disabled.</p></li>
|
||||
<li><p>Fix crash that could occur when changing the palette id in the tileset palette editor.</p></li>
|
||||
|
|
@ -454,32 +539,32 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id21">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.0.0...1.1.0">1.1.0</a> - 2018-12-27<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id22">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id28">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.0.0...1.1.0">1.1.0</a> - 2018-12-27<a class="headerlink" href="#id28" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id29">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id29" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>New map header format in pokeemerald from commit <a class="reference external" href="https://github.com/pret/pokeemerald/commit/a1ea3b5e394bc115ba9b86348c161094a00dcca7">a1ea3b5e394bc115ba9b86348c161094a00dcca7</a>.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id23">
|
||||
<h3>Added<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id30">
|
||||
<h3>Added<a class="headerlink" href="#id30" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add <code class="docutils literal notranslate"><span class="pre">porymap.project.cfg</span></code> config file to project repos, in order to house project-specific settings, such as <code class="docutils literal notranslate"><span class="pre">base_game_version=pokeemerald</span></code>.</p></li>
|
||||
<li><p>Write all logs to <code class="docutils literal notranslate"><span class="pre">porymap.log</span></code> file, so users can view any errors that porymap hits.</p></li>
|
||||
<li><p>Changelog</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id24">
|
||||
<h3>Changed<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id31">
|
||||
<h3>Changed<a class="headerlink" href="#id31" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add <code class="docutils literal notranslate"><span class="pre">porymap.cfg</span></code> base config file, rather than using built-in system settings (e.g. registry on Windows).</p></li>
|
||||
<li><p>Properly read/write map headers for <code class="docutils literal notranslate"><span class="pre">pokeemerald</span></code>.</p></li>
|
||||
<li><p>Overhauled event editing pane, which now contains tabs for each different event. Events of the same type can be iterated through using the spinner at the top of the tab. This makes it possible to edit events that are outside the viewing window.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id25">
|
||||
<h3>Fixed<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id32">
|
||||
<h3>Fixed<a class="headerlink" href="#id32" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Creating new hidden-item events now uses a valid default flag value.</p></li>
|
||||
<li><p>Fix bug where tilesets were sometimes not displaying their bottom row of metatiles.</p></li>
|
||||
|
|
@ -492,8 +577,8 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id26">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/tree/1.0.0">1.0.0</a> - 2018-10-26<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id33">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/tree/1.0.0">1.0.0</a> - 2018-10-26<a class="headerlink" href="#id33" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This was the initial release.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -518,7 +603,7 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -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#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#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#open-map-scripts">Open Map Scripts</a></li>
|
||||
</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>
|
||||
</ul>
|
||||
</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-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>
|
||||
|
|
@ -145,56 +150,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../manual/scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../manual/scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../manual/project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Related Projects</a></li>
|
||||
|
|
@ -266,6 +299,10 @@
|
|||
|
||||
<div class="section" id="related-projects">
|
||||
<h1>Related Projects<a class="headerlink" href="#related-projects" title="Permalink to this headline">¶</a></h1>
|
||||
<p><a class="reference external" href="https://github.com/Rangi42/polished-map">Polished Map</a> - A map editor for pokecrystal, pokered, and other Gen 1/2 disassembly projects.</p>
|
||||
<p><a class="reference external" href="https://github.com/huderlem/poryscript">Poryscript</a> - A high-level scripting language meant to be used with the decompilation projects.</p>
|
||||
<p><a class="reference external" href="https://github.com/Kermalis/VGMusicStudio">VG Music Studio</a> - A program that lets you listen to the music from popular video game formats.</p>
|
||||
<p><a class="reference external" href="https://github.com/Rangi42/tilemap-studio">Tilemap Studio</a> - A tilemap editor for Game Boy, Color, and Advance projects.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -286,7 +323,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -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#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#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#open-map-scripts">Open Map Scripts</a></li>
|
||||
</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>
|
||||
</ul>
|
||||
</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-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>
|
||||
|
|
@ -145,56 +150,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/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></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">3.0.1 - 2020-03-04</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#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<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#added">Added</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">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Fixed</a></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#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Fixed</a></li>
|
||||
<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#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Added</a></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.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id20">Fixed</a></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#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id25">Fixed</a></li>
|
||||
<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#id26">1.0.0 - 2018-10-26</a></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>
|
||||
|
|
@ -288,7 +321,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -16,7 +16,6 @@ github:
|
|||
@make html
|
||||
rm -rf ../docs
|
||||
@cp -a $(BUILDDIR)/html/. ../docs
|
||||
touch ../docs/.nojekyll
|
||||
@rm reference/changelog.md
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@
|
|||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = u'porymap'
|
||||
copyright = u'2019, huderlem'
|
||||
copyright = u'2020, huderlem'
|
||||
author = u'huderlem'
|
||||
|
||||
# The short X.Y version
|
||||
|
|
@ -36,21 +36,17 @@ release = u''
|
|||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = []
|
||||
extensions = [
|
||||
'recommonmark',
|
||||
'sphinx.ext.githubpages',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
|
||||
from recommonmark.parser import CommonMarkParser
|
||||
|
||||
source_suffix = ['.rst', '.md']
|
||||
source_parsers = {
|
||||
'.md': CommonMarkParser,
|
||||
}
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
|
|
|||
|
|
@ -16,7 +16,9 @@ Porymap Documentation
|
|||
manual/editing-map-header
|
||||
manual/editing-map-connections
|
||||
manual/editing-wild-encounters
|
||||
manual/creating-new-maps
|
||||
manual/region-map-editor
|
||||
manual/scripting-capabilities
|
||||
manual/project-files
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
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.
|
||||
|
|
@ -9,7 +9,7 @@ Events are what bring your maps to life. They include NPCs, signposts, warps, s
|
|||
|
||||
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
|
||||
: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".
|
||||
|
||||
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
|
||||
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:
|
||||
|
||||
Warp Events
|
||||
|
|
@ -116,7 +119,7 @@ Var Value
|
|||
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
|
||||
:alt: Weather Trigger Event Properties
|
||||
|
|
@ -167,10 +170,17 @@ Item
|
|||
Flag
|
||||
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
|
||||
-----------------
|
||||
|
||||
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
|
||||
:alt: Secret Base Event Properties
|
||||
|
|
@ -183,6 +193,22 @@ Id
|
|||
Secret Base Id
|
||||
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
|
||||
------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ Weather
|
|||
The weather that is running when entering the map.
|
||||
|
||||
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
|
||||
Controls what graphics are used in battles.
|
||||
|
|
@ -36,8 +36,11 @@ Allow Running
|
|||
Allow Biking
|
||||
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.
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
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
|
||||
-------------------
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 400 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 109 KiB |
BIN
docsrc/manual/images/editing-map-events/event-heal-location.png
Normal file
BIN
docsrc/manual/images/editing-map-events/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 |
Binary file not shown.
|
After Width: | Height: | Size: 243 KiB |
|
|
@ -14,7 +14,7 @@ Porymap reads and writes files in the decompilation projects. It **does not** r
|
|||
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:
|
||||
|
||||
|
|
|
|||
|
|
@ -25,6 +25,8 @@ Sort by Area
|
|||
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.
|
||||
|
||||
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.
|
||||
|
||||
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
|
||||
-----------------
|
||||
|
||||
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
|
||||
: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/metatiles.inc, yes, yes, also edits metatile files listed in this file
|
||||
src/data/wild_encounters.json, yes, yes,
|
||||
src/data/field_event_obj/event_object_graphics_info_pointers.h, yes, no,
|
||||
src/data/field_event_obj/event_object_graphics_info.h, yes, no,
|
||||
src/data/field_event_obj/event_object_pic_tables.h, yes, no,
|
||||
src/data/field_event_obj/event_object_graphics.h, yes, no,
|
||||
src/data/object_events/object_event_graphics_info_pointers.h, yes, no,
|
||||
src/data/object_events/object_event_graphics_info.h, yes, no,
|
||||
src/data/object_events/object_event_pic_tables.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/heal_locations.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/pokemon.h, yes, no, reads min and max level constants
|
||||
include/constants/map_types.h, yes, no,
|
||||
include/constants/secret_bases.h, yes, no,
|
||||
include/constants/event_object_movement_constants.h, yes, no,
|
||||
include/constants/bg_event_constants.h, yes, no,
|
||||
include/constants/trainer_types.h, yes, no,
|
||||
include/constants/secret_bases.h, yes, no, pokeemerald and pokeruby only
|
||||
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/metatile_labels.h, yes, yes,
|
||||
include/constants/metatile_behaviors.h, yes, no,
|
||||
include/constants/bg_event_constants.h, yes, no,
|
||||
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
|
||||
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:
|
||||
|
||||
.. figure:: images/region-map-editor/rme-new-window.png
|
||||
|
|
|
|||
551
docsrc/manual/scripting-capabilities.rst
Normal file
551
docsrc/manual/scripting-capabilities.rst
Normal file
|
|
@ -0,0 +1,551 @@
|
|||
**********************
|
||||
Scripting Capabilities
|
||||
**********************
|
||||
|
||||
Porymap is extensible via scripting capabilities. This allows the user to write custom JavaScript (technically, ECMAScript) files to support enhanced workflows, without having to fork Porymap itself. While the possibilities are endless, some useful examples of scripting might be:
|
||||
|
||||
- Toggle Day/Night Palettes
|
||||
- Custom Map Painting Brushes
|
||||
- Detect Tile Errors
|
||||
- Show Diagonistic Information
|
||||
- Procedurally Generated Maps
|
||||
- Randomize Grass Patterns
|
||||
|
||||
Writing a Custom Script
|
||||
-----------------------
|
||||
|
||||
Let's write a custom script that will randomize grass patterns when the user is editing the map. This is useful, since it's cumbersome to manually add randomness to grass patches. With the custom script, it will happen automatically. Whenever the user paints a grass tile onto the map, the script will overwrite the tile with a random grass tile instead.
|
||||
|
||||
First, create a new script file called ``my_script.js``--place it in the project directory (e.g. ``pokefirered/``).
|
||||
|
||||
Next, open the Porymap project config file, ``porymap.project.cfg``, in the project directory. Add the script file to the ``custom_scripts`` configuration value. Multiple script files can be loaded by separating the filepaths with a comma.
|
||||
|
||||
.. code-block::
|
||||
|
||||
custom_scripts=my_script.js
|
||||
|
||||
Now that Porymap is configured to load the script file, let's write the actual code that will power the grass-randomizer. Scripts have access to several "callbacks" for events that occur while Porymap is running. This means our script can define functions for each of these callbacks. We're interested in the ``onBlockChanged()`` callback, since we want our script to take action whenever a user paints a block on the map.
|
||||
|
||||
.. code-block:: js
|
||||
|
||||
// Porymap callback when a block is painted.
|
||||
export function onBlockChanged(x, y, prevBlock, newBlock) {
|
||||
// Grass-randomizing logic goes here.
|
||||
}
|
||||
|
||||
It's very **important** to remember to ``export`` the callback functions in the script. Otherwise, Porymap will not be able to execute them.
|
||||
|
||||
In addition to the callbacks, Porymap also supports a scripting API so that the script can interact with Porymap in interesting ways. For example, a script can change a block or add overlay text on the map. Since we want to paint random grass tiles, we'll be using the ``map.setMetatileId()`` function. Let's fill in the rest of the grass-randomizing code.
|
||||
|
||||
.. code-block:: js
|
||||
|
||||
function randInt(min, max) {
|
||||
min = Math.ceil(min);
|
||||
max = Math.floor(max);
|
||||
return Math.floor(Math.random() * (max - min)) + min;
|
||||
}
|
||||
|
||||
// These are the grass metatiles in pokefirered.
|
||||
const grassTiles = [0x8, 0x9, 0x10, 0x11];
|
||||
|
||||
// Porymap callback when a block is painted.
|
||||
export function onBlockChanged(x, y, prevBlock, newBlock) {
|
||||
// Check if the user is painting a grass tile.
|
||||
if (grassTiles.indexOf(newBlock.metatileId) != -1) {
|
||||
// Choose a random grass tile and paint it on the map.
|
||||
const i = randInt(0, grassTiles.length);
|
||||
map.setMetatileId(x, y, grassTiles[i]);
|
||||
}
|
||||
}
|
||||
|
||||
Let's test the script out by re-launching Porymap. If we try to paint grass on the map, we should see our script inserting a nice randomized grass pattern.
|
||||
|
||||
.. figure:: images/scripting-capabilities/porymap-scripting-grass.gif
|
||||
:alt: Grass-Randomizing Script
|
||||
|
||||
Grass-Randomizing Script
|
||||
|
||||
Registering Script Actions
|
||||
--------------------------
|
||||
|
||||
The grass-randomizer script above happens implicitly when the user paints on the map. However, other times we probably want to call the custom script on demand. One of the API functions Porymap provides is the ability to trigger scripting functions from the ``Tools`` menu, or a keyboard shortcut. To do this, we will usually want to register the action when the project loads. Here is an example script where some custom actions are registered.
|
||||
|
||||
.. code-block:: js
|
||||
|
||||
function applyNightTint() {
|
||||
// Apply night palette tinting...
|
||||
}
|
||||
|
||||
// Porymap callback when project is opened.
|
||||
export function onProjectOpened(projectPath) {
|
||||
map.registerAction("applyNightTint", "View Night Tint", "T")
|
||||
}
|
||||
|
||||
Then, to trigger the ``applyNightTint()`` function, we could either click ``Tools -> View Night Tint`` or use the ``T`` keyboard shortcut.
|
||||
|
||||
Now that we have an overview of how to utilize Porymap's scripting capabilities, the entire scripting API is documented below.
|
||||
|
||||
Scripting API
|
||||
-------------
|
||||
|
||||
Callbacks
|
||||
~~~~~~~~~
|
||||
|
||||
.. js:function:: onProjectOpened(projectPath)
|
||||
|
||||
Called when Porymap successfully opens a project.
|
||||
|
||||
:param string projectPath: the directory path of the opened project
|
||||
|
||||
.. js:function:: onProjectClosed(projectPath)
|
||||
|
||||
Called when Porymap closes a project. For example, this is called when opening a different project.
|
||||
|
||||
:param string projectPath: the directory path of the closed project
|
||||
|
||||
.. js:function:: onMapOpened(mapName)
|
||||
|
||||
Called when a map is opened.
|
||||
|
||||
:param string mapName: the name of the opened map
|
||||
|
||||
.. js:function:: onBlockChanged(x, y, prevBlock, newBlock)
|
||||
|
||||
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.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param object prevBlock: the block's state before it was modified. The object's shape is ``{metatileId, collision, elevation, rawValue}``
|
||||
:param object newBlock: the block's new state after it was modified. The object's shape is ``{metatileId, collision, elevation, rawValue}``
|
||||
|
||||
Functions
|
||||
~~~~~~~~~
|
||||
|
||||
All scripting functions are callable via the global ``map`` object.
|
||||
|
||||
Map Editing Functions
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following functions are related to editing the map's blocks or retrieving information about them.
|
||||
|
||||
.. js:function:: map.getBlock(x, y)
|
||||
|
||||
Gets a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns {metatileId, collision, elevation, rawValue}: the block object
|
||||
|
||||
.. js:function:: map.setBlock(x, y, metatileId, collision, elevation, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Sets a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number metatileId: the metatile id of the block
|
||||
:param number collision: the collision of the block (``0`` = passable, ``1`` = impassable)
|
||||
:param number elevation: the elevation of the block
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.getMetatileId(x, y)
|
||||
|
||||
Gets the metatile id of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns number: the metatile id of the block
|
||||
|
||||
.. js:function:: map.setMetatileId(x, y, metatileId, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Sets the metatile id of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number metatileId: the metatile id of the block
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.getCollision(x, y)
|
||||
|
||||
Gets the collision of a block in the currently-opened map. (``0`` = passable, ``1`` = impassable)
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns number: the collision of the block
|
||||
|
||||
.. js:function:: map.setCollision(x, y, collision, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Sets the collision of a block in the currently-opened map. (``0`` = passable, ``1`` = impassable)
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number collision: the collision of the block
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.getElevation(x, y)
|
||||
|
||||
Gets the elevation of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns number: the elevation of the block
|
||||
|
||||
.. js:function:: map.setElevation(x, y, elevation, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Sets the elevation of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number elevation: the elevation of the block
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.setBlocksFromSelection(x, y, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Sets blocks on the map using the user's current metatile selection.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.bucketFill(x, y, metatileId, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Performs a bucket fill of a metatile id, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param number metatileId: metatile id to fill
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.bucketFillFromSelection(x, y, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Performs a bucket fill using the user's current metatile selection, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.magicFill(x, y, metatileId, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Performs a magic fill of a metatile id, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param number metatileId: metatile id to magic fill
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.magicFillFromSelection(x, y, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Performs a magic fill using the user's current metatile selection, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.shift(xDelta, yDelta, forceRedraw = true, commitChanges = true)
|
||||
|
||||
Performs a shift on the map's blocks.
|
||||
|
||||
:param number xDelta: number of blocks to shift horizontally
|
||||
:param number yDelta: number of blocks to shift vertically
|
||||
:param boolean forceRedraw: Force the map view to refresh. Defaults to ``true``. Redrawing the map view is expensive, so set to ``false`` when making many consecutive map edits, and then redraw the map once using ``map.redraw()``.
|
||||
:param boolean commitChanges: Commit the changes to the map's edit/undo history. Defaults to ``true``. When making many related map edits, it can be useful to set this to ``false``, and then commit all of them together with ``map.commit()``.
|
||||
|
||||
.. js:function:: map.getDimensions()
|
||||
|
||||
Gets the dimensions of the currently-opened map.
|
||||
|
||||
:returns {width, height}: the dimensions of the map
|
||||
|
||||
.. js:function:: map.getWidth()
|
||||
|
||||
Gets the width of the currently-opened map.
|
||||
|
||||
:returns number: the width of the map
|
||||
|
||||
.. js:function:: map.getHeight()
|
||||
|
||||
Gets the height of the currently-opened map.
|
||||
|
||||
:returns number: the height of the map
|
||||
|
||||
.. js:function:: map.setDimensions(width, height)
|
||||
|
||||
Sets the dimensions of the currently-opened map.
|
||||
|
||||
:param number width: width in blocks
|
||||
:param number height: height in blocks
|
||||
|
||||
.. js:function:: map.setWidth(width)
|
||||
|
||||
Sets the width of the currently-opened map.
|
||||
|
||||
:param number width: width in blocks
|
||||
|
||||
.. js:function:: map.setHeight()
|
||||
|
||||
Sets the height of the currently-opened map.
|
||||
|
||||
:param number height: height in blocks
|
||||
|
||||
.. js:function:: map.redraw()
|
||||
|
||||
Redraws the entire map area. Useful when delaying map redraws using ``forceRedraw = false`` in certain map editing functions.
|
||||
|
||||
.. js:function:: map.commit()
|
||||
|
||||
Commits any uncommitted changes to the map's edit/undo history. Useful when delaying commits using ``commitChanges = false`` in certain map editing functions.
|
||||
|
||||
Map Overlay Functions
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
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.
|
||||
|
||||
.. js:function:: map.clearOverlay()
|
||||
|
||||
Clears and erases all overlay items that were previously-added to the map.
|
||||
|
||||
.. js:function:: map.addText(text, x, y, color = "#000000", size = 12)
|
||||
|
||||
Adds a text item to the overlay.
|
||||
|
||||
:param string text: the text to display
|
||||
:param number x: the x pixel coordinate of the text
|
||||
:param number y: the y pixel coordinate of the text
|
||||
:param string color: the color of the text. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.
|
||||
:param number size: the font size of the text. Defaults to 12.
|
||||
|
||||
.. js:function:: map.addRect(x, y, width, height, color = "#000000")
|
||||
|
||||
Adds a rectangle outline item to the overlay.
|
||||
|
||||
:param number x: the x pixel coordinate of the rectangle's top-left corner
|
||||
:param number y: the y pixel coordinate of the rectangle's top-left corner
|
||||
:param number width: the pixel width of the rectangle
|
||||
:param number height: the pixel height of the rectangle
|
||||
:param string color: the color of the rectangle. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.
|
||||
|
||||
.. js:function:: map.addFilledRect(x, y, width, height, color = "#000000")
|
||||
|
||||
Adds a filled rectangle item to the overlay.
|
||||
|
||||
:param number x: the x pixel coordinate of the rectangle's top-left corner
|
||||
:param number y: the y pixel coordinate of the rectangle's top-left corner
|
||||
:param number width: the pixel width of the rectangle
|
||||
:param number height: the pixel height of the rectangle
|
||||
:param string color: the color of the rectangle. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.
|
||||
|
||||
.. js:function:: map.addImage(x, y, filepath)
|
||||
|
||||
Adds an image item to the overlay.
|
||||
|
||||
:param number x: the x pixel coordinate of the image's top-left corner
|
||||
:param number y: the y pixel coordinate of the image's top-left corner
|
||||
:param string filepath: the image's filepath
|
||||
|
||||
Tileset Functions
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
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.
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalettePreview(paletteIndex)
|
||||
|
||||
Gets a palette from the primary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalettePreview(paletteIndex, colors)
|
||||
|
||||
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.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalettesPreview()
|
||||
|
||||
Gets all of the palettes from the primary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalettesPreview(palettes)
|
||||
|
||||
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.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalettePreview(paletteIndex)
|
||||
|
||||
Gets a palette from the secondary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalettePreview(paletteIndex, colors)
|
||||
|
||||
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.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalettesPreview()
|
||||
|
||||
Gets all of the palettes from the secondary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalettesPreview(palettes)
|
||||
|
||||
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.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalette(paletteIndex)
|
||||
|
||||
Gets a palette from the primary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalette(paletteIndex, colors)
|
||||
|
||||
Sets a palette in the primary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalettes()
|
||||
|
||||
Gets all of the palettes from the primary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalettes(palettes)
|
||||
|
||||
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.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalette(paletteIndex)
|
||||
|
||||
Gets a palette from the secondary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalette(paletteIndex, colors)
|
||||
|
||||
Sets a palette in the secondary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalettes()
|
||||
|
||||
Gets all of the palettes from the secondary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalettes(palettes)
|
||||
|
||||
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.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTileset()
|
||||
|
||||
Gets the name of the primary tileset for the currently-opened map.
|
||||
|
||||
:returns string: primary tileset name
|
||||
|
||||
.. js:function:: map.setPrimaryTileset(tileset)
|
||||
|
||||
Sets the primary tileset for the currently-opened map.
|
||||
|
||||
:param string tileset: the tileset name
|
||||
|
||||
.. js:function:: map.getSecondaryTileset()
|
||||
|
||||
Gets the name of the secondary tileset for the currently-opened map.
|
||||
|
||||
:returns string: secondary tileset name
|
||||
|
||||
.. js:function:: map.setSecondaryTileset(tileset)
|
||||
|
||||
Sets the secondary tileset for the currently-opened map.
|
||||
|
||||
:param string tileset: the tileset name
|
||||
|
||||
Settings Functions
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following functions are related to settings.
|
||||
|
||||
.. js:function:: map.getGridVisibility()
|
||||
|
||||
Gets the visibility of the map grid overlay.
|
||||
|
||||
:returns boolean: grid visibility
|
||||
|
||||
.. js:function:: map.setGridVisibility(visible)
|
||||
|
||||
Sets the visibility of the map grid overlay.
|
||||
|
||||
:param boolean visible: grid visibility
|
||||
|
||||
.. js:function:: map.getBorderVisibility()
|
||||
|
||||
Gets the visibility of the map's border.
|
||||
|
||||
:returns boolean: border visibility
|
||||
|
||||
.. js:function:: map.setBorderVisibility(visible)
|
||||
|
||||
Sets the visibility of the map's border.
|
||||
|
||||
:param boolean visible: border visibility
|
||||
|
||||
.. js:function:: map.getSmartPathsEnabled()
|
||||
|
||||
Gets the toggle state of smart paths.
|
||||
|
||||
:returns boolean: smart paths enabled
|
||||
|
||||
.. js:function:: map.setSmartPathsEnabled(enabled)
|
||||
|
||||
Sets the toggle state of smart paths.
|
||||
|
||||
:param boolean enabled: smart paths enabled
|
||||
|
||||
Utility Functions
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
These are some miscellaneous functions that can be very useful when building custom scripts.
|
||||
|
||||
.. js:function:: map.registerAction(functionName, actionName, shortcut = "")
|
||||
|
||||
Registers a JavaScript function to an action that can be manually triggered in Porymap's ``Tools`` menu. Optionally, a keyboard shortcut (e.g. ``"Ctrl+P"``) can also be specified, assuming it doesn't collide with any existing shortcuts used by Porymap.
|
||||
|
||||
:param string functionName: name of the JavaScript function
|
||||
:param string actionName: name of the action that will be displayed in the ``Tools`` menu
|
||||
:param string shortcut: optional keyboard shortcut
|
||||
|
||||
.. js:function:: map.setTimeout(func, delayMs)
|
||||
|
||||
This behaves essentially the same as JavaScript's ``setTimeout()`` that is used in web browsers or NodeJS. The ``func`` 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.
|
||||
|
||||
:param function func: a JavaScript function that will be executed later
|
||||
:param number delayMs: the number of milliseconds to wait before executing ``func``
|
||||
|
||||
.. js:function:: map.log(message)
|
||||
|
||||
Logs a message to the Porymap log file. This is useful for debugging custom scripts.
|
||||
|
||||
:param string message: the message to log
|
||||
|
|
@ -1,3 +1,16 @@
|
|||
****************
|
||||
Related Projects
|
||||
****************
|
||||
****************
|
||||
|
||||
`Polished Map`_ - A map editor for pokecrystal, pokered, and other Gen 1/2 disassembly projects.
|
||||
|
||||
Poryscript_ - A high-level scripting language meant to be used with the decompilation projects.
|
||||
|
||||
`VG Music Studio`_ - A program that lets you listen to the music from popular video game formats.
|
||||
|
||||
`Tilemap Studio`_ - A tilemap editor for Game Boy, Color, and Advance projects.
|
||||
|
||||
.. _Polished Map: https://github.com/Rangi42/polished-map
|
||||
.. _Poryscript: https://github.com/huderlem/poryscript
|
||||
.. _VG Music Studio: https://github.com/Kermalis/VGMusicStudio
|
||||
.. _Tilemap Studio: https://github.com/Rangi42/tilemap-studio
|
||||
|
|
|
|||
Loading…
Reference in a new issue