Add documentation for prefabs

This commit is contained in:
Marcus Huderle 2022-09-10 13:08:48 -05:00
parent b14d8b8a88
commit b92fdaf94e
42 changed files with 3335 additions and 955 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 483 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 682 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 352 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 384 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 378 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 384 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 378 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 714 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 611 KiB

View file

@ -18,6 +18,7 @@ Porymap Documentation
manual/editing-wild-encounters
manual/creating-new-maps
manual/region-map-editor
manual/tileset-editor
manual/scripting-capabilities
manual/project-files
manual/shortcuts

View file

@ -60,7 +60,7 @@ Object events are typically used for NPCs (non-player-characters). More technic
Object Event Properties
Id
This is the local id of the object in the map. Some script values use this local id to specify object when using scripting commands such as `applymovement`.
This is the local id of the object in the map. Some script values use this local id to specify an object when using scripting commands such as `applymovement`.
Sprite
The sprite that is used by the object.
@ -83,8 +83,27 @@ Trainer Type
Sight Radius or Berry Tree ID
If the object is a trainer, this property control how many tiles the trainer can see to spot the player for battle. If the object is a berry tree, this specifies the global id of the berry tree. Each berry tree in the game has a unique berry tree id.
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.
Clone Object Events
-------------------
Clone Object events are a special type of object that inherits its properties from another Object event. They are used in-game to load objects that are visible in the connecting area of adjacent maps. The targeted object to clone is specified by id and map name. If the targeted object does not exist, or it's also a clone, the sprite for graphics id 0 will be displayed instead. Double-clicking on a Clone Object will open the targeted map with the targeted object selected. This event type is exclusive to pokefirered projects; the code to process them does not exist in pokeemerald/pokeruby.
.. figure:: images/editing-map-events/event-clone-object.png
:alt: Clone Object Event Properties
Clone Object Event Properties
Id
This is the local id of the object in the map. Some script values use this local id to specify an object when using scripting commands such as `applymovement`.
Sprite
The sprite that is used by the object. Clone Objects inherit their sprite from the targeted object, so this cannot be edited. This field is not actually read by the game.
Target Local Id
The local id of the object to be cloned.
Target Map
The name of the map the object to be cloned is on.
.. _event-warps:

View file

@ -167,3 +167,31 @@ Undo & Redo
-----------
When painting metatiles, you can undo and redo actions you take. This makes it very easy to fix mistakes or go back in time. Undo can be performed with ``Ctrl+Z`` or *Edit -> Undo*. Redo can be performed with ``Ctrl+Y`` or *Edit -> Redo*.
Prefabs
-------
Prefabs, or "prefabricated selections", are a way to optimize your map-editing workflow by defining pre-built metatile selections. This can be useful when larger map objects can't be selected from the main metatile selector window. For example, the Poké Mart building is only partially selectable in the metatile selector view.
.. figure:: images/editing-map-tiles/prefab-list.png
:alt: Prefab Tab
Prefab Tab
To create a new prefab, simply select a group of metatiles from the main map view. (See the `Selecting Metatiles`_. section above for how to use right-click-drag to select from the map area.) Then, click the "Create from Selection" button. This will bring up the following window where individual metatiles can be toggled on/off in the prefab. You can also give your prefab a name.
.. figure:: images/editing-map-tiles/prefab-create.png
:alt: Prefab Creation Window
Prefab Creation Window
Prefabs are designated for whichever primary and secondary tilesets were used to create them. As such, any prefabs for with tilesets that are incompatible with the currently-opened map will be hidden from the Prefab list.
To select a prefab to use for painting on the map, simply click on the prefab image in the list view.
.. figure:: images/editing-map-tiles/prefab-demo.gif
:alt: Painting with a Prefab
Painting with a Prefab
Prefab data is saved to a JSON file. It defaults to ``<project_root>/prefabs.json``. However, it can be configured in Porymap's project config file.

View file

@ -73,7 +73,8 @@ Wild Pokémon Tab
Tileset Editor
--------------
The Tileset Editor can be opened with *File -> Tileset Editor* (``Ctrl+T``). When the Tileset Editor is opened, it is opened in the context of the currently-opened map. Every map has a primary and secondary tileset, so you will work with a combination of the two whenever you use the Tileset Editor. The left-side pane shows the primary and secondary tilesets' metatiles. The right-side panes allow you to modify the currently-selected metatile.
The Tileset Editor can be opened with *File -> Tileset Editor* (``Ctrl+T``).
Check out :ref:`The Tileset Editor <tse-ref>` section for more details.
.. figure:: images/navigation/tileset-editor.png
:alt: Tileset Editor
@ -83,11 +84,13 @@ The Tileset Editor can be opened with *File -> Tileset Editor* (``Ctrl+T``). Wh
Region Map Editor
-----------------
The Region Map Editor can be opened with *File -> Region Map Editor* (``Ctrl+M``). 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.
The Region Map Editor can be opened with *File -> Region Map Editor* (``Ctrl+M``).
This window will allow you to modify the look and layout of maps on the game's region map.
Check out :ref:`The Region Map Editor <rme-ref>` section for more details.
.. figure:: images/navigation/region-map-editor.png
:alt: Region Map Editor
Region Map Editor
We covered all of the basic views and windows of Porymap above. Next, let's learn how to use Porymap's features to the fullest when editing map tiles.
We covered all of the basic views and windows of porymap above. Next, let's learn how to use Porymap's features to the fullest when editing map tiles.

View file

@ -1,25 +1,76 @@
.. _rme-ref:
*********************
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.
This is where you edit the region maps for your game. You are able to edit the
background tilemap, the layout of map sections, and the array of map section entries
which determines the dimensions of each section.
.. note::
The region map editor is currently only available for pokeemerald and pokeruby.
To open the region map editor, navigate to *Tools -> Region Map Editor* from
porymap's main window. There is also a keyboard shortcut which is by default ``Ctrl+M``.
When you first open the region map editor, your window will look like this:
When you first open the region map editor, you will need to configure porymap to
read your region map data. There are defaults for every base game project available
which should be sufficient for most users.
.. figure:: images/region-map-editor/rme-new-window.png
:scale: 75%
.. figure:: images/region-map-editor/new-configure-window.png
:align: center
:width: 75%
:alt: RME Window
Region Maps Configurator
Porymap supports multiple region maps for any project.
By default, pokeemerald and pokefirered use this feature.
For a more custom region map, you can use the *Add Region Map...* button to
create a new region map configuration from scratch. You can also double-click on any existing
region map in the list to bring this window up to make changes.
.. figure:: images/region-map-editor/rme-config-properties.png
:align: center
:width: 50%
:alt: RME Config Prop
Region Map Properties Window
This window has many options for users to define:
.. csv-table::
:header: Field,Explanation,Restrictions
:widths: 10, 30, 20
alias,something for porymap to distinguish between your maps,unique & valid json string
**Tilemap Properties**,,
format,format of the tiles,Plain *or* 4bpp *or* 8bpp
width,width *in tiles* of the tilemap,16 *or* 32 *or* 64 *or* 128
height,height *in tiles* of the tilemap,valid corresponding height based on width
tileset path,the relative path to the tile image from project root,valid filepath string
tilemap path,the relative path to the tilemap binary from project root,valid filepath string
palette path,*optional* relative path to ``.pal`` file from project root,valid filepath string
**Layout Properties**,*can be unchecked for maps without layouts*,
format,the format to read the layout file,C array *or* binary
layout path,the relative path from project root to layout file,valid filepath string
width,the width of the layout,non-negative integer
left offset,the position on the tilemap which defines layout x=0,width + left offset < tilemap width
height,the height of the layout,non-negative integer
top offset,the position on the tilemap which defines layout y=0,height + top offset < tilemap height
When you are finished configuring your region maps, you can select *OK*. This will
display the main editor window.
.. figure:: images/region-map-editor/rme-main-window.png
:align: center
:width: 75%
:alt: RME Config Prop
Region Map Editor Window
This window is split vertically--the region map editing is done at the top,
while the zoomed-in city maps are edited at the bottom. You can use the
sliders to zoom in and out on each of the view panes. You will notice
This window has a combobox labeled "Region" which you can use to select the current
region map you want to edit.
You will notice
that there are three different tabs above the image of the region map
(:ref:`Background Image <background-image-tab>`,
:ref:`Map Layout <map-layout-tab>`,
@ -39,24 +90,13 @@ are unhappy with what you have done, you can undo (``Ctrl+Z`` or *Edit -> Undo*)
and redo (``Ctrl+Y`` or *Edit -> Redo*) your changes. Right-clicking on the map
image will select the tile under your mouse from the tile selector.
If your tilemap format is not "Plain", then you can also select the palette,
h-flip, and v-flip of any tile you are painting with.
If you want to clear the background image, *Edit -> Clear Background Image*
will set all tiles to the first tile in the tile selector.
.. figure:: images/region-map-editor/rme-painting-image.gif
:scale: 75%
:align: center
:alt: RME Paint
Drawing on the Region Map Image
It is likely that you will want to use your own tiles for your region map. You
can import a tile image by navigating to *Tools -> Import Region Map Image Tiles*.
There are strict requirements for your region map tile image. It must (1) be
indexed with a 256 color palette\*, (2) be composed of 8x8 pixel tiles, (3) have 256
or fewer tiles.
\* While the region map tile image requires a 256-color palette, the image only
uses the 32 colors beginning at index 112 in the palette.
You can use the sliders to zoom in and out on each of the view panes.
.. _map-layout-tab:
@ -67,9 +107,9 @@ The layout tab is where map sections are placed on the region map. When the
player looks at the region map in-game, the layout determines the map under the
cursor.
.. figure:: images/region-map-editor/rme-layout-tab.png
:scale: 75%
.. figure:: images/region-map-editor/rme-new-layout-tab.png
:align: center
:width: 75%
:alt: RME Layout
RME Layout Tab
@ -78,29 +118,15 @@ To modify the region map layout, select a position by clicking on the map image
and higlighting a single square. The "Map Section" combobox will be populated
with all of the map sections defined in ``include/constants/region_map_sections.h``.
Select the map section you want to associate with the selected position on the
region map. To change the popup name of the map section when you enter the map,
type it into the "Map Name" box. The popup name is tied to the map section, so
each layout square with the same map section will share a name.
region map.
If you want to start from a blank layout, *Edit -> Clear Map Layout* will set
all layout squares to the value of ``MAPSEC_NONE``.
There are a couple of tools which make editing multiple layout squares simultaneously easier.
When adding new region map sections, the layout will be affected. This is
because the layout is stored as a binary file and uses the raw value of each
map section. In order to fix your layout to account for this, you can swap two
values for the entire layout with *Edit -> Swap*.
*Edit -> Clear Map Layout* will set all squares in the layout to ``MAPSEC_NONE``.
In this example, ``MAPSEC_NEW_MAPSEC`` is inserted before ``MAPSEC_NONE``, and
therefore the layout will link the original value of ``MAPSEC_NONE`` to the new
map section ``MAPSEC_NEW_MAPSEC``. Instances of ``MAPSEC_NEW_MAPSEC`` are swapped
with ``MAPSEC_NONE``.
*Edit -> Swap Layout Sections...* will exchange two layout sections with each other.
.. figure:: images/region-map-editor/rme-layout-swap.gif
:scale: 75%
:align: center
:alt: RME Swap
Swapping Map Sections
*Edit -> Replace Layout Section...* will replace all instances of one section with another.
The "Delete Square" button simply resets a single layout square to ``MAPSEC_NONE``.
@ -111,10 +137,10 @@ Map Entries Tab
A region map entry is the area on the region map that spans an entire map section.
This determines, for example, where the player's head appears on the region map
in-game. Entries are stored at ``src/data/region_map/region_map_entries.h``.
in-game. Entries are stored in ``src/data/region_map/region_map_sections.json``.
.. figure:: images/region-map-editor/rme-entries-tab.png
:scale: 75%
.. figure:: images/region-map-editor/rme-new-entries-tab.png
:width: 75%
:align: center
:alt: RME Entries
@ -126,29 +152,8 @@ You can also drag the entry around the map. The "x" and "y" values correspond t
the position of the entry's top-left square on the region map. The "Dimensions"
"width" and "height" spinboxes will change the size of the map entry.
City Maps
---------
In the bottom half of the region map editor window, city maps can be edited.
You paint on this the same way you paint on the region map background image.
.. figure:: images/region-map-editor/rme-painting-city.gif
:scale: 60%
:align: center
:alt: City Paint
Drawing on the City Map
To use custom tiles, there is a tile image importer under
*Tools -> Import City Map Image Tiles*. These images must (1) be indexed with a
16 color palette, (2) be made up of 8x8 pixel tiles, (3) have 256 or fewer tiles.
You can add a new city map by pressing the |new-city-map-button| button.
.. |new-city-map-button|
image:: images/region-map-editor/rme-new-city-map-button.png
Currently, it is not possible to associate a city map to a region map location,
but that functionality will be added in a future update.
To change the popup name of the map section when you enter the map, type it
into the "Map Name" box.

View file

@ -118,6 +118,15 @@ Callbacks
: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}``
.. js:function:: onBorderMetatileChanged(x, y, prevMetatileId, newMetatileId)
Called when a border metatile is changed.
:param number x: x coordinate of the block
:param number y: y coordinate of the block
:param number prevMetatileId: the metatile id of the border block before it was modified
:param number newMetatileId: the metatile id of the border block after it was modified
.. js:function:: onBlockHoverChanged(x, y)
Called when the mouse enters a new map block.
@ -138,6 +147,15 @@ Callbacks
:param number newWidth: the width of the map after the change
:param number newHeight: the height of the map after the change
.. js:function:: onBorderResized(oldWidth, oldHeight, newWidth, newHeight)
Called when the dimensions of the border are changed.
:param number oldWidth: the width of the border before the change
:param number oldHeight: the height of the border before the change
:param number newWidth: the width of the border after the change
:param number newHeight: the height of the border after the change
.. js:function:: onMapShifted(xDelta, yDelta)
Called when the map is updated by use of the Map Shift tool.
@ -165,6 +183,12 @@ Callbacks
:param number oldTab: the index of the previously selected tab
:param number newTab: the index of the newly selected tab
.. js:function:: onBorderVisibilityToggled(visible)
Called when the visibility of the border and connecting maps is toggled on or off.
:param boolean visible: whether the border is now visible
Functions
~~~~~~~~~
@ -190,11 +214,21 @@ The following functions are related to editing the map's blocks or retrieving in
: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 collision: the collision of the block (``0`` = passable, ``1-3`` = 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.setBlock(x, y, rawValue, forceRedraw = true, commitChanges = true)
Sets a block in the currently-opened map. This is an overloaded function that takes the raw value of a block instead of each of the block's properties individually.
:param number x: x coordinate of the block
:param number y: y coordinate of the block
:param number rawValue: the 16 bit value of the block. Bits ``0-9`` will be the metatile id, bits ``10-11`` will be the collision, and bits ``12-15`` will be the elevation.
: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.
@ -213,9 +247,27 @@ The following functions are related to editing the map's blocks or retrieving in
: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.getBorderMetatileId(x, y)
Gets the metatile id of a block in the border of 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.setBorderMetatileId(x, y, metatileId, forceRedraw = true, commitChanges = true)
Sets the metatile id of a block in the border of 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)
Gets the collision of a block in the currently-opened map. (``0`` = passable, ``1-3`` = impassable)
:param number x: x coordinate of the block
:param number y: y coordinate of the block
@ -223,7 +275,7 @@ The following functions are related to editing the map's blocks or retrieving in
.. 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)
Sets the collision of a block in the currently-opened map. (``0`` = passable, ``1-3`` = impassable)
:param number x: x coordinate of the block
:param number y: y coordinate of the block
@ -323,6 +375,24 @@ The following functions are related to editing the map's blocks or retrieving in
:returns number: the height of the map
.. js:function:: map.getBorderDimensions()
Gets the dimensions of the border of the currently-opened map.
:returns {width, height}: the dimensions of the border
.. js:function:: map.getBorderWidth()
Gets the width of the border of the currently-opened map.
:returns number: the width of the border
.. js:function:: map.getBorderHeight()
Gets the height of the border of the currently-opened map.
:returns number: the height of the border
.. js:function:: map.setDimensions(width, height)
Sets the dimensions of the currently-opened map.
@ -342,6 +412,25 @@ The following functions are related to editing the map's blocks or retrieving in
:param number height: height in blocks
.. js:function:: map.setBorderDimensions(width, height)
Sets the dimensions of the border of the currently-opened map. If the config setting ``use_custom_border_size`` is set to ``0`` then this does nothing.
:param number width: width in blocks
:param number height: height in blocks
.. js:function:: map.setBorderWidth(width)
Sets the width of the border of the currently-opened map. If the config setting ``use_custom_border_size`` is set to ``0`` then this does nothing.
:param number width: width in blocks
.. js:function:: map.setBorderHeight(height)
Sets the height of the border of the currently-opened map. If the config setting ``use_custom_border_size`` is set to ``0`` then this does nothing.
: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.
@ -350,6 +439,143 @@ The following functions are related to editing the map's blocks or retrieving in
Commits any uncommitted changes to the map's edit/undo history. Useful when delaying commits using ``commitChanges = false`` in certain map editing functions.
Map Header Editing Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following functions are related to reading/writing the map's header properties.
.. js:function:: map.getSong()
Gets the name of the background song for the currently-opened map.
:returns string: the name of the song
.. js:function:: map.setSong(song)
Sets the name of the background song for the currently-opened map. The song name must be one of the names in the "Song" dropdown menu on the Header tab.
:param string song: the name of the song
.. js:function:: map.getLocation()
Gets the name of the region map location for the currently-opened map.
:returns string: the name of the location
.. js:function:: map.setLocation(location)
Sets the name of the region map location for the currently-opened map. The location name must be one of the names in the "Location" dropdown menu on the Header tab.
:param string location: the name of the location
.. js:function:: map.getRequiresFlash()
Gets whether flash would be required in-game for the currently-opened map.
:returns boolean: whether flash is required
.. js:function:: map.setRequiresFlash(require)
Sets whether flash would be required in-game for the currently-opened map.
:param boolean require: whether flash should be required
.. js:function:: map.getWeather()
Gets the name of the weather for the currently-opened map.
:returns string: the name of the weather
.. js:function:: map.setWeather(weather)
Sets the name of the weather for the currently-opened map. The weather name must be one of the names in the "Weather" dropdown menu on the Header tab.
:param string weather: the name of the weather
.. js:function:: map.getType()
Gets the name of the map type for the currently-opened map.
:returns string: the name of the map type
.. js:function:: map.setType(type)
Sets the name of the map type for the currently-opened map. The map type name must be one of the names in the "Type" dropdown menu on the Header tab.
:param string type: the name of the map type
.. js:function:: map.getBattleScene()
Gets the name of the battle scene for the currently-opened map.
:returns string: the name of the battle scene
.. js:function:: map.setBattleScene(battleScene)
Sets the name of the battle scene for the currently-opened map. The battle scene name must be one of the names in the "Battle scene" dropdown menu on the Header tab.
:param string battleScene: the name of the battle scene
.. js:function:: map.getShowLocationName()
Gets whether the location name will appear in-game for the currently-opened map.
:returns boolean: whether the location name will be shown
.. js:function:: map.setShowLocationName(show)
Sets whether the location name should appear in-game for the currently-opened map.
:param boolean show: whether the location name should be shown
.. js:function:: map.getAllowRunning()
Gets whether running is allowed in-game for the currently-opened map.
:returns boolean: whether running is allowed
.. js:function:: map.setAllowRunning(allow)
Sets whether running should be allowed in-game for the currently-opened map.
:param boolean allow: whether running should be allowed
.. js:function:: map.getAllowBiking()
Gets whether biking is allowed in-game for the currently-opened map.
:returns boolean: whether biking is allowed
.. js:function:: map.setAllowBiking(allow)
Sets whether biking should be allowed in-game for the currently-opened map.
:param boolean allow: whether biking should be allowed
.. js:function:: map.getAllowEscaping()
Gets whether escaping (using Escape Rope or Dig) is allowed in-game for the currently-opened map.
:returns boolean: whether escaping is allowed
.. js:function:: map.setAllowEscaping(allow)
Sets whether escaping (using Escape Rope or Dig) should be allowed in-game for the currently-opened map.
:param boolean allow: whether escaping should be allowed
.. js:function:: map.getFloorNumber()
Gets the floor number for the currently-opened map.
:returns number: the floor number
.. js:function:: map.setFloorNumber(floorNumber)
Sets the floor number for the currently-opened map. Floor numbers can be any number between -128 and 127 inclusive.
:param number floorNumber: the floor number
Map Overlay Functions
^^^^^^^^^^^^^^^^^^^^^
@ -405,6 +631,26 @@ The following functions are related to an overlay that is drawn on top of the ma
:param boolean visible: whether the layers should be showing
.. js:function:: map.getOverlayOpacity(layer = 0)
Gets the opacity of the specified overlay layer. Opacity ranges from 0 (invisible) to 100 (completely opaque).
:param number layer: the layer id. Defaults to ``0``
:returns number: the opacity
.. js:function:: map.setOverlayOpacity(opacity, layer = 0)
Sets the opacity of the specified overlay layer. Opacity ranges from 0 (invisible) to 100 (completely opaque).
:param number opacity: the opacity
:param number layer: the layer id. Defaults to ``0``
.. js:function:: map.setOverlaysOpacity(opacity)
Sets the opacity of all active overlay layers. Opacity ranges from 0 (invisible) to 100 (completely opaque).
:param number opacity: the opacity
.. js:function:: map.getOverlayX(layer = 0)
Gets the x position of the specified overlay layer.
@ -525,18 +771,18 @@ The following functions are related to an overlay that is drawn on top of the ma
:param number layer: the layer id. Defaults to ``0``
:param boolean useCache: whether the image should be saved/loaded using the cache. Defaults to ``true``. Reading images from a file is slow. Setting ``useCache`` to ``true`` will save the image to memory so that the next time the filepath is encountered the image can be loaded from memory rather than the file.
.. js:function:: map.createImage(x, y, filepath, width = -1, height = -1, offset = 0, xflip = false, yflip = false, paletteId = -1, setTransparency = false, layer = 0, useCache = true)
.. js:function:: map.createImage(x, y, filepath, width = -1, height = -1, offset = 0, hScale = 1, vScale = 1, paletteId = -1, setTransparency = false, layer = 0, useCache = true)
Creates an image item on the specified overlay layer. This differs from ``map.addImage`` by allowing the new image to be a transformation of the image file.
:param number x: the x pixel coordinate of the image's top-left corner (relative to the layer's position)
:param number y: the y pixel coordinate of the image's top-left corner (relative to the layer's position)
:param string filepath: the image's filepath
:param number width: the image width. If ``-1``, use the full width of the original image. Defaults to ``-1``
:param number height: the image height. If ``-1``, use the full height of the original image. Defaults to ``-1``
:param number width: the width in pixels of the area to read in the image. If ``-1``, use the full width of the original image. Defaults to ``-1``
:param number height: the height in pixels of the area to read in the image. If ``-1``, use the full height of the original image. Defaults to ``-1``
:param number offset: the pixel offset into the original image where data should be read from. Defaults to ``0``
:param boolean xflip: whether the image should be a horizontal flip of the original image. Defaults to ``false``
:param boolean yflip: whether the image should be a vertical flip of the original image. Defaults to ``false``
:param number hScale: the horizontal scale for the image. Negative values will be a horizontal flip of the original image. Defaults to ``1``
:param number vScale: the vertical scale for the image. Negative values will be a vertical flip of the original image. Defaults to ``1``
:param number paletteId: the id of which currently loaded tileset palette to use for the image. If ``-1``, use the original image's palette. Defaults to ``-1``
:param boolean setTransparency: whether the color at index 0 should be overwritten with transparent pixels. Defaults to ``false``
:param number layer: the layer id. Defaults to ``0``
@ -887,6 +1133,22 @@ The following functions are related to tilesets and how they are rendered. The f
:param number metatileId: id of target metatile
:param number behavior: the behavior
.. js:function:: map.getMetatileAttributes(metatileId)
Gets the raw attributes value for the specified metatile.
:param number metatileId: id of target metatile
:returns number: the raw attributes value
.. js:function:: map.setMetatileAttributes(metatileId, attributes)
Sets the raw attributes value for the specified metatile.
**Warning:** This function writes directly to the tileset. There is no undo for this. Porymap will not limit the value of existing attributes to their usual range.
:param number metatileId: id of target metatile
:param number attributes: the raw attributes value
.. js:function:: map.getMetatileTile(metatileId, tileIndex)
Gets the tile at the specified index of the metatile.
@ -957,7 +1219,11 @@ The following functions are related to tilesets and how they are rendered. The f
:param number tileEnd: index of the last tile to set. Defaults to ``-1`` (the last tile)
: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()``.
.. js:function:: map.getTilePixels(tileId)
Gets the pixel data for the specified tile. The pixel data is an array of indexes indicating which palette color each pixel uses. Tiles are 8x8, so the pixel array will be 64 elements long.
:returns array: the pixel data
Settings Functions
^^^^^^^^^^^^^^^^^^
@ -1006,6 +1272,12 @@ The following functions are related to settings.
:returns string: ``"pokeruby"``, ``"pokefirered"``, or ``"pokeemerald"``
.. js:function:: map.getPorymapVersion()
Gets the current version of Porymap (``MAJOR.MINOR.PATCH``).
:returns {major, minor, patch}: the version object
.. js:function:: map.getCustomScripts()
Gets the list of paths to custom scripts.
@ -1068,9 +1340,74 @@ These are some miscellaneous functions that can be very useful when building cus
:param string message: the message to log
.. js:function:: map.error(message)
Logs a message to the Porymap log file with the prefix ``[ERROR]``.
:param string message: the message to log
.. js:function:: map.showMessage(text, informativeText, detailedText)
Displays a message box with an "Information" icon and an ``OK`` button. Execution stops while the window is open.
:param string text: the main message text
:param string informativeText: smaller text below the main message. Defaults to ``""``
:param string detailedText: text hidden behind a "Show Details" box. Defaults to ``""``
.. js:function:: map.showWarning(text, informativeText, detailedText)
Displays a message box with a "Warning" icon and an ``OK`` button. Execution stops while the window is open.
:param string text: the main message text
:param string informativeText: smaller text below the main message. Defaults to ``""``
:param string detailedText: text hidden behind a "Show Details" box. Defaults to ``""``
.. js:function:: map.showError(text, informativeText, detailedText)
Displays a message box with a "Critical" icon and an ``OK`` button. Execution stops while the window is open.
:param string text: the main message text
:param string informativeText: smaller text below the main message. Defaults to ``""``
:param string detailedText: text hidden behind a "Show Details" box. Defaults to ``""``
.. js:function:: map.showQuestion(text, informativeText, detailedText)
Displays a message box with a "Question" icon and a ``Yes`` and a ``No`` button. Execution stops while the window is open.
:param string text: the main message text
:param string informativeText: smaller text below the main message. Defaults to ``""``
:param string detailedText: text hidden behind a "Show Details" box. Defaults to ``""``
:returns boolean: ``true`` if ``Yes`` was selected, ``false`` if ``No`` was selected or if the window was closed without selection
.. js:function:: map.getInputText(title, label, default)
Displays a text input dialog with an ``OK`` and a ``Cancel`` button. Execution stops while the window is open.
:param string title: the text in the window title bar
:param string label: the text adjacent to the input entry area
:param string default: the text in the input entry area when the window is opened. Defaults to ``""``
:returns {input, ok}: ``input`` will be the input text and ``ok`` will be ``true`` if ``OK`` was selected. ``input`` will be ``""`` and ``ok`` will be ``false`` if ``Cancel`` was selected or if the window was closed without selection.
.. js:function:: map.getInputNumber(title, label, default, min, max, decimals, step)
Displays a number input dialog with an ``OK`` and a ``Cancel`` button. Execution stops while the window is open.
:param string title: the text in the window title bar
:param string label: the text adjacent to the input entry area
:param number default: the number in the input entry area when the window is opened. Defaults to ``0``
:param number min: the minimum allowable input value. Defaults to ``-2147483648``
:param number max: the maximum allowable input value. Defaults to ``2147483647``
:param number decimals: the number of decimals used for the input number. Defaults to ``0``
:param number step: the increment by which the input number will change when the spinner is used. Defaults to ``1``
:returns {input, ok}: ``input`` will be the input number and ``ok`` will be ``true`` if ``OK`` was selected. ``input`` will be ``default`` and ``ok`` will be ``false`` if ``Cancel`` was selected or if the window was closed without selection.
.. js:function:: map.getInputItem(title, label, items, default, editable)
Displays a text input dialog with an items dropdown and an ``OK`` and a ``Cancel`` button. Execution stops while the window is open.
:param string title: the text in the window title bar
:param string label: the text adjacent to the input entry area
:param array items: an array of text items that will populate the dropdown
:param number default: the index of the item to select by default. Defaults to ``0``
:param boolean editable: whether the user is allowed to enter their own text instead. Defaults to ``false``
:returns {input, ok}: ``input`` will be the input text and ``ok`` will be ``true`` if ``OK`` was selected. ``input`` will be the text of the item at ``default`` and ``ok`` will be ``false`` if ``Cancel`` was selected or if the window was closed without selection.

View file

@ -17,6 +17,7 @@ determined by this file.
:widths: 10, 3, 5, 5, 20
``recent_project``, , global, yes, The project that will be opened on launch
``reopen_on_launch``, 1, global, yes, Whether the most recent project should be opened on launch
``recent_map``, , global, yes, The map that will be opened on launch
``pretty_cursors``, 1, global, yes, Whether to use custom crosshair cursors
``map_sort_order``, group, global, yes, The order map list is sorted in
@ -39,13 +40,14 @@ determined by this file.
``use_custom_border_size``, 0, project, yes, Whether to allow variable border sizes
``enable_event_weather_trigger``, 1 if not ``pokefirered``, project, yes, Allows adding Weather Trigger events
``enable_event_secret_base``, 1 if not ``pokefirered``, project, yes, Allows adding Secret Base events
``enable_event_clone_object``, 1 if ``pokefirered``, project, yes, Allows adding Clone Object events
``enable_hidden_item_quantity``, 1 if ``pokefirered``, project, yes, Adds ``Quantity`` to Hidden Item events
``enable_hidden_item_requires_itemfinder``, 1 if ``pokefirered``, project, yes, Adds ``Requires Itemfinder`` to Hidden Item events
``enable_heal_location_respawn_data``, 1 if ``pokefirered``, project, yes, Adds ``Respawn Map`` and ``Respawn NPC`` to Heal Location events
``enable_object_event_in_connection``, 1 if ``pokefirered``, project, yes, Adds ``In Connection`` to Object events
``enable_floor_number``, 1 if ``pokefirered``, project, yes, Adds ``Floor Number`` to map headers
``create_map_text_file``, 1 if not ``pokeemerald``, project, yes, A ``text.inc`` or ``text.pory`` file will be created for any new map
``enable_triple_layer_metatiles``, 0, project, yes, Enables triple-layer metatiles (See https://github.com/pret/pokeemerald/wiki/Triple-layer-metatiles)
``custom_scripts``, , project, yes, A list of script files to load into the scripting engine
``prefabs_filepath``, ``<project_root>/prefabs.json``, project, yes, The filepath containing prefab JSON data
Some of these settings can be toggled manually in porymap via the *Options* menu.

View file

@ -0,0 +1,163 @@
.. _tse-ref:
*********************
The Tileset Editor
*********************
Here, you can edit individual tilesets.
When the Tileset Editor is opened, it is opened in the context of the
currently-opened map. Every map has a primary and secondary tileset, so you
will work with a combination of the two whenever you use the Tileset Editor.
The left-side pane shows the primary and secondary tilesets' metatiles.
The right-side panes allow you to modify the currently-selected metatile.
.. figure:: images/tileset-editor/tse-open-window.png
:align: center
:width: 75%
:alt: TSE Window
Tileset Editor Window
Metatile Properties
===================
.. figure:: images/tileset-editor/tse-metatile-properties.png
:align: center
:width: 30%
:alt: MP Frame
Metatile Properties Panel
Layer Type
----------
Defines the background layers the metatiles will use for drawing.
The options are:
**Normal** --- Metatile uses middle and top bg layers
**Covered** --- Metatile uses bottom and middle bg layers
**Split** --- Metatile uses bottom and top bg layers
Metatile Behavior
-----------------
Defines the metatile behavior associated with this metatile. This can be used
for a variety of different reasons. For example, warps, ice, and tall grass effects
are all determined by a metatile's behavior.
This dropdown is populated with constants found in ``include/constants/metatile_behaviors.h``.
Encounter Type
--------------
*pokefirered exclusive*
Used to determine which category of wild encounter to attempt.
Terrain Type
------------
*pokefirered exclusive*
Used to determine certain attributes of metatiles. Can be useful in certain scenarios.
For example, to determine if the player is facing water or standing in grass.
Metatile Label
--------------
*optional*
A name can be given to metatiles so that they may be referenced in source code.
These are defined in ``include/constants/metatile_labels.h`` and can be used in
together with the ``METATILE_ID`` macro.
For example, the metatile pictured above can be accessed like
``METATILE_ID(General, Plain_Grass)``.
Tools Menu
==========
The tileset editor provides users with several useful tools for making edits
easier and more convenient.
Import Tiles Image...
---------------------
Tool to automatically import a new tile image for a tileset.
The tile image is an indexed png of 8x8 pixel tiles, which are used to form
metatiles in the tileset editor.
Import Metatiles from Advance Map 1.92...
-----------------------------------------
Helpful for users converting projects from binary hacks.
Metatile data exported from Advance Map 1.92 in a ``.bvd``` file can be imported
into porymap's tileset editor.
This saves a lot of time since metatiles will not have to be defined from scratch.
Change Number of Metatiles
--------------------------
The number of metatiles in both the current primary and current secondary tileset
can be adjusted within the limits.
.. note::
You may need to change the Makefile rules for the number of tiles allowed
for the tileset in the file ``graphics_file_rules.mk``. You can simply
remove the ``-num_tiles=`` argument altogether.
Other Tools
-----------
.. figure:: images/tileset-editor/tse-display-tool.png
:align: center
:width: 60%
:alt: TSE Unused
Displaying Unused Tiles
There are also tools to count the number of metatile and tile usages across the
entire project, which can be useful, for example, in determining whether a
metatile can be deleted. The output of these operations is pictured above.
Palette Editor
==============
The palette editor is where the ``.pal`` files are modified for each tileset.
.. figure:: images/tileset-editor/pe-open-window.png
:align: center
:width: 75%
:alt: PE
Palette Editor
The current palette is indicated by the spinner at the top left. To switch
between palettes, just change the spinner value.
At the top right is a setting for the bit depth at which colors are displayed.
The colors in a palette file are displayed as 24 bit numbers, but the GBA
hardware only allows 15 bit colors, so displaying in 15 bits can be more realistic.
Each individual color can be adjusted with either the sliders or the spinners,
in addition to the hex value box. Each color also has an eyedropper toolbutton
which allows users to pick any color from the screen and add it to the palette.
Entire palettes can also be imported from a variety of formats,
including JASC, Adobe Color Table, Tile Layer Pro, and Advance PE.
Each imported palette must contain 16 colors.

View file

@ -7,7 +7,37 @@ and this project somewhat adheres to [Semantic Versioning](https://semver.org/sp
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.
### Breaking Changes
- Proper support for pokefirered's clone objects was added, which requires the changes made in [pokefirered/#484](https://github.com/pret/pokefirered/pull/484).
### Added
- Add Copy/Paste for metatiles in the Tileset Editor.
- Add new features to the scripting API, including the ability to display message boxes and user input windows, set overlay opacity, get/set map header properties, read tile pixel data, and set blocks or metatile attributes using a raw value.
- Add button to copy the full metatile label to the clipboard in the Tileset Editor.
- Add option to not open the most recent project on launch.
- Add color picker to palette editor for taking colors from the screen.
### Changed
- Overhauled the region map editor, adding support for tilemaps, and significant customization. Also now supports pokefirered.
- If an object event is inanimate, it will always render using its first frame.
- Only log "Unknown custom script function" when a registered script function is not present in any script.
- Unused metatile attribute bits that are set are preserved instead of being cleared.
- The wild encounter editor is automatically disabled if the encounter JSON data cannot be read
- Metatiles are always rendered accurately with 3 layers, and the unused layer is not assumed to be transparent.
- `object_event_graphics_info.h` can now be parsed correctly if it uses structs with attributes.
- The selection is no longer reset when pasting events. The newly pasted events are selected instead.
- Palette editor ui is updated a bit to allow hex and rgb value input.
### Fixed
- Fix cursor tile outline not updating at the end of a dragged selection.
- Fix cursor tile and player view outlines exiting map bounds while painting.
- Fix cursor tile and player view outlines not updating immediately when toggled in Collision view.
- Fix selected space not updating while painting in Collision view.
- Fix collision values of 2 or 3 not rendering properly.
- Fix the map music dropdown being empty when importing a map from Advance Map.
- Fix object events added by pasting ignoring the map event limit.
- Fixed a bug where saving the tileset editor would reselect the main editor's first selected metatile.
- Fix crashes / unexpected behavior if certain scripting API functions are given invalid palette or tile numbers.
## [4.5.0] - 2021-12-26
### Added
@ -287,7 +317,7 @@ Nothing, yet.
This was the initial release.
[Unreleased]: https://github.com/huderlem/porymap/compare/4.5.0...HEAD
[4.5.0]: https://github.com/huderlem/porymap/compare/4.4.0...4.4.0
[4.5.0]: https://github.com/huderlem/porymap/compare/4.4.0...4.5.0
[4.4.0]: https://github.com/huderlem/porymap/compare/4.3.1...4.4.0
[4.3.1]: https://github.com/huderlem/porymap/compare/4.3.0...4.3.1
[4.3.0]: https://github.com/huderlem/porymap/compare/4.2.0...4.3.0

View file

@ -108,6 +108,7 @@
<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 &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-collisions.html">Editing Map Collisions</a><ul>
@ -120,6 +121,7 @@
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#object-events">Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#clone-object-events">Clone Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
@ -152,7 +154,25 @@
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-entries-tab">Map Entries Tab</a></li>
<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/tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#palette-editor">Palette Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
@ -162,6 +182,7 @@
<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-header-editing-functions">Map Header 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>
@ -184,94 +205,100 @@
<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">4.5.0 - 2021-12-26</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#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#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id4">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id4">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id6">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id9">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id5">4.4.0 - 2020-12-20</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id10">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id11">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id13">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id9">4.3.1 - 2020-07-17</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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id14">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id16">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id16">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id18">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id20">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id21">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id17">4.2.0 - 2020-06-06</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id22">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#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#id21">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id23">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id26">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id27">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id25">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id26">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id27">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id28">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id29">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id28">3.0.0 - 2020-03-04</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>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id30">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id31">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id33">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id34">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id35">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id36">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id37">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id32">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id33">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id34">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id35">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id36">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id38">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id37">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id38">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id41">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id42">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id42">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id43">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id44">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id44">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id45">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id45">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id46">Breaking Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id46">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id47">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id48">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id49">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id50">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id51">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id52">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id53">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id54">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id49">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id55">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id54">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id55">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id56">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id57">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id58">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id59">1.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>
@ -362,7 +389,7 @@
</li>
<li><a href="manual/scripting-capabilities.html#map.addText">map.addText() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#id0">map.addTileImage() (map method)</a>, <a href="manual/scripting-capabilities.html#map.addTileImage">[1]</a>
<li><a href="manual/scripting-capabilities.html#id1">map.addTileImage() (map method)</a>, <a href="manual/scripting-capabilities.html#map.addTileImage">[1]</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.bucketFill">map.bucketFill() (map method)</a>
</li>
@ -377,12 +404,28 @@
<li><a href="manual/scripting-capabilities.html#map.createImage">map.createImage() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.error">map.error() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getAllowBiking">map.getAllowBiking() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getAllowEscaping">map.getAllowEscaping() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getAllowRunning">map.getAllowRunning() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getBaseGameVersion">map.getBaseGameVersion() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getBattleScene">map.getBattleScene() (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.getBorderDimensions">map.getBorderDimensions() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getBorderHeight">map.getBorderHeight() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getBorderMetatileId">map.getBorderMetatileId() (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.getBorderWidth">map.getBorderWidth() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getCollision">map.getCollision() (map method)</a>
</li>
@ -391,10 +434,20 @@
<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.getFloorNumber">map.getFloorNumber() (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.getInputItem">map.getInputItem() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getInputNumber">map.getInputNumber() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getInputText">map.getInputText() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getLocation">map.getLocation() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getMainTab">map.getMainTab() (map method)</a>
</li>
@ -407,6 +460,8 @@
<li><a href="manual/scripting-capabilities.html#map.getMaxSecondaryTilesetMetatiles">map.getMaxSecondaryTilesetMetatiles() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getMaxSecondaryTilesetTiles">map.getMaxSecondaryTilesetTiles() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getMetatileAttributes">map.getMetatileAttributes() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getMetatileBehavior">map.getMetatileBehavior() (map method)</a>
</li>
@ -439,6 +494,8 @@
<li><a href="manual/scripting-capabilities.html#map.getNumSecondaryTilesetTiles">map.getNumSecondaryTilesetTiles() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getNumTilesInMetatile">map.getNumTilesInMetatile() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getOverlayOpacity">map.getOverlayOpacity() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getOverlayPosition">map.getOverlayPosition() (map method)</a>
</li>
@ -447,6 +504,8 @@
<li><a href="manual/scripting-capabilities.html#map.getOverlayX">map.getOverlayX() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getOverlayY">map.getOverlayY() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getPorymapVersion">map.getPorymapVersion() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getPrimaryTileset">map.getPrimaryTileset() (map method)</a>
</li>
@ -457,6 +516,8 @@
<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.getRequiresFlash">map.getRequiresFlash() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getSecondaryTileset">map.getSecondaryTileset() (map method)</a>
</li>
@ -467,10 +528,20 @@
<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.getShowLocationName">map.getShowLocationName() (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.getSong">map.getSong() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getTilePixels">map.getTilePixels() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getType">map.getType() (map method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manual/scripting-capabilities.html#map.getSmartPathsEnabled">map.getSmartPathsEnabled() (map method)</a>
<li><a href="manual/scripting-capabilities.html#map.getWeather">map.getWeather() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.getWidth">map.getWidth() (map method)</a>
</li>
@ -496,25 +567,47 @@
</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><a href="manual/scripting-capabilities.html#map.setAllowBiking">map.setAllowBiking() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setAllowEscaping">map.setAllowEscaping() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setAllowRunning">map.setAllowRunning() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setBattleScene">map.setBattleScene() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#id0">map.setBlock() (map method)</a>, <a href="manual/scripting-capabilities.html#map.setBlock">[1]</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.setBorderDimensions">map.setBorderDimensions() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setBorderHeight">map.setBorderHeight() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setBorderMetatileId">map.setBorderMetatileId() (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.setBorderWidth">map.setBorderWidth() (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.setFloorNumber">map.setFloorNumber() (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.setLocation">map.setLocation() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setMainTab">map.setMainTab() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setMapViewTab">map.setMapViewTab() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setMetatileAttributes">map.setMetatileAttributes() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setMetatileBehavior">map.setMetatileBehavior() (map method)</a>
</li>
@ -532,11 +625,15 @@
</li>
<li><a href="manual/scripting-capabilities.html#map.setMetatileTerrainType">map.setMetatileTerrainType() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#id1">map.setMetatileTile() (map method)</a>, <a href="manual/scripting-capabilities.html#map.setMetatileTile">[1]</a>
<li><a href="manual/scripting-capabilities.html#id2">map.setMetatileTile() (map method)</a>, <a href="manual/scripting-capabilities.html#map.setMetatileTile">[1]</a>
</li>
<li><a href="manual/scripting-capabilities.html#id2">map.setMetatileTiles() (map method)</a>, <a href="manual/scripting-capabilities.html#map.setMetatileTiles">[1]</a>
<li><a href="manual/scripting-capabilities.html#id3">map.setMetatileTiles() (map method)</a>, <a href="manual/scripting-capabilities.html#map.setMetatileTiles">[1]</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setOverlayOpacity">map.setOverlayOpacity() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setOverlayPosition">map.setOverlayPosition() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setOverlaysOpacity">map.setOverlaysOpacity() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setOverlaysPosition">map.setOverlaysPosition() (map method)</a>
</li>
@ -561,6 +658,8 @@
<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.setRequiresFlash">map.setRequiresFlash() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setSecondaryTileset">map.setSecondaryTileset() (map method)</a>
</li>
@ -571,18 +670,34 @@
<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.setShowLocationName">map.setShowLocationName() (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.setSong">map.setSong() (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.setType">map.setType() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.setWeather">map.setWeather() (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>
<li><a href="manual/scripting-capabilities.html#map.showError">map.showError() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.showMessage">map.showMessage() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.showOverlay">map.showOverlay() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.showOverlays">map.showOverlays() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.showQuestion">map.showQuestion() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.showWarning">map.showWarning() (map method)</a>
</li>
<li><a href="manual/scripting-capabilities.html#map.warn">map.warn() (map method)</a>
</li>
@ -598,12 +713,18 @@
</li>
<li><a href="manual/scripting-capabilities.html#onBlockHoverCleared">onBlockHoverCleared() (built-in function)</a>
</li>
<li><a href="manual/scripting-capabilities.html#onMainTabChanged">onMainTabChanged() (built-in function)</a>
<li><a href="manual/scripting-capabilities.html#onBorderMetatileChanged">onBorderMetatileChanged() (built-in function)</a>
</li>
<li><a href="manual/scripting-capabilities.html#onMapOpened">onMapOpened() (built-in function)</a>
<li><a href="manual/scripting-capabilities.html#onBorderResized">onBorderResized() (built-in function)</a>
</li>
<li><a href="manual/scripting-capabilities.html#onBorderVisibilityToggled">onBorderVisibilityToggled() (built-in function)</a>
</li>
<li><a href="manual/scripting-capabilities.html#onMainTabChanged">onMainTabChanged() (built-in function)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manual/scripting-capabilities.html#onMapOpened">onMapOpened() (built-in function)</a>
</li>
<li><a href="manual/scripting-capabilities.html#onMapResized">onMapResized() (built-in function)</a>
</li>
<li><a href="manual/scripting-capabilities.html#onMapShifted">onMapShifted() (built-in function)</a>

View file

@ -108,6 +108,7 @@
<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 &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-collisions.html">Editing Map Collisions</a><ul>
@ -120,6 +121,7 @@
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#object-events">Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#clone-object-events">Clone Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
@ -152,7 +154,25 @@
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-entries-tab">Map Entries Tab</a></li>
<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/tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#palette-editor">Palette Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
@ -162,6 +182,7 @@
<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-header-editing-functions">Map Header 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>
@ -184,94 +205,100 @@
<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">4.5.0 - 2021-12-26</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#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#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id4">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id4">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id6">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id9">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id5">4.4.0 - 2020-12-20</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id10">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id11">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id13">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id9">4.3.1 - 2020-07-17</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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id14">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id16">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id16">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id18">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id20">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id21">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id17">4.2.0 - 2020-06-06</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id22">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#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#id21">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id23">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id26">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id27">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id25">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id26">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id27">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id28">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id29">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id28">3.0.0 - 2020-03-04</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>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id30">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id31">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id33">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id34">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id35">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id36">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id37">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id32">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id33">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id34">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id35">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id36">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id38">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id37">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id38">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id41">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id42">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id42">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id43">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id44">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id44">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id45">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id45">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id46">Breaking Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id46">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id47">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id48">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id49">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id50">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id51">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id52">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id53">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id54">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id49">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id55">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id54">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id55">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id56">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id57">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id58">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id59">1.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>
@ -374,6 +401,7 @@
<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 &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-collisions.html">Editing Map Collisions</a><ul>
@ -386,6 +414,7 @@
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#object-events">Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#clone-object-events">Clone Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
@ -418,7 +447,12 @@
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-entries-tab">Map Entries Tab</a></li>
<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/tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#metatile-properties">Metatile Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#tools-menu">Tools Menu</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#palette-editor">Palette Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
@ -443,20 +477,20 @@
<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">4.5.0 - 2021-12-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">4.4.0 - 2020-12-20</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id6">4.3.1 - 2020-07-17</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id10">4.3.0 - 2020-06-27</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id14">4.2.0 - 2020-06-06</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id18">4.1.0 - 2020-05-18</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id22">4.0.0 - 2020-04-28</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id26">3.0.1 - 2020-03-04</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id28">3.0.0 - 2020-03-04</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id33">2.0.0 - 2019-10-16</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id38">1.2.2 - 2019-05-16</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id42">1.2.1 - 2019-02-16</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id45">1.2.0 - 2019-02-04</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id50">1.1.0 - 2018-12-27</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id55">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id5">4.4.0 - 2020-12-20</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id9">4.3.1 - 2020-07-17</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">4.3.0 - 2020-06-27</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id17">4.2.0 - 2020-06-06</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id21">4.1.0 - 2020-05-18</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id25">4.0.0 - 2020-04-28</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id30">3.0.1 - 2020-03-04</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id32">3.0.0 - 2020-03-04</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id37">2.0.0 - 2019-10-16</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id42">1.2.2 - 2019-05-16</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id46">1.2.1 - 2019-02-16</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id49">1.2.0 - 2019-02-04</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id54">1.1.0 - 2018-12-27</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id59">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>

View file

@ -109,6 +109,7 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-collisions.html">Editing Map Collisions</a><ul>
@ -121,6 +122,7 @@
<li class="toctree-l2"><a class="reference internal" href="#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#object-events">Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="#clone-object-events">Clone Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="#weather-trigger-events">Weather Trigger Events</a></li>
@ -153,7 +155,25 @@
<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="tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#palette-editor">Palette Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
@ -163,6 +183,7 @@
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-header-editing-functions">Map Header Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#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>
@ -185,94 +206,100 @@
<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">4.5.0 - 2021-12-26</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#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#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">4.4.0 - 2020-12-20</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id10">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">4.3.1 - 2020-07-17</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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id14">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id17">4.2.0 - 2020-06-06</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id22">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#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#id21">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id25">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id28">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">3.0.0 - 2020-03-04</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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id30">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id37">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id32">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id33">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id38">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id37">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id38">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id41">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id43">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id45">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id45">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id46">Breaking Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id46">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id47">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id49">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id50">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id54">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id49">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id55">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id54">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id55">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id56">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id57">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id58">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id59">1.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>
@ -381,7 +408,7 @@
<p class="caption"><span class="caption-text">Object Event Properties</span><a class="headerlink" href="#id5" title="Permalink to this image"></a></p>
</div>
<dl class="simple">
<dt>Id</dt><dd><p>This is the local id of the object in the map. Some script values use this local id to specify object when using scripting commands such as <cite>applymovement</cite>.</p>
<dt>Id</dt><dd><p>This is the local id of the object in the map. Some script values use this local id to specify an object when using scripting commands such as <cite>applymovement</cite>.</p>
</dd>
<dt>Sprite</dt><dd><p>The sprite that is used by the object.</p>
</dd>
@ -397,16 +424,32 @@
</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 maps 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 objects local id on the connecting map.</p>
</dl>
</div>
<div class="section" id="clone-object-events">
<h2>Clone Object Events<a class="headerlink" href="#clone-object-events" title="Permalink to this headline"></a></h2>
<p>Clone Object events are a special type of object that inherits its properties from another Object event. They are used in-game to load objects that are visible in the connecting area of adjacent maps. The targeted object to clone is specified by id and map name. If the targeted object does not exist, or its also a clone, the sprite for graphics id 0 will be displayed instead. Double-clicking on a Clone Object will open the targeted map with the targeted object selected. This event type is exclusive to pokefirered projects; the code to process them does not exist in pokeemerald/pokeruby.</p>
<div class="figure align-default" id="id6">
<img alt="Clone Object Event Properties" src="../_images/event-clone-object.png" />
<p class="caption"><span class="caption-text">Clone Object Event Properties</span><a class="headerlink" href="#id6" title="Permalink to this image"></a></p>
</div>
<dl class="simple">
<dt>Id</dt><dd><p>This is the local id of the object in the map. Some script values use this local id to specify an object when using scripting commands such as <cite>applymovement</cite>.</p>
</dd>
<dt>Sprite</dt><dd><p>The sprite that is used by the object. Clone Objects inherit their sprite from the targeted object, so this cannot be edited. This field is not actually read by the game.</p>
</dd>
<dt>Target Local Id</dt><dd><p>The local id of the object to be cloned.</p>
</dd>
<dt>Target Map</dt><dd><p>The name of the map the object to be cloned is on.</p>
</dd>
</dl>
</div>
<div class="section" id="warp-events">
<span id="event-warps"></span><h2>Warp Events<a class="headerlink" href="#warp-events" title="Permalink to this headline"></a></h2>
<p>Warp events are how the player is able to warp to other maps, such as entering a building. Double-clicking on a warp will automatically open the destination map and select the destination warp. This makes it very easy to navigate around in Porymap.</p>
<div class="figure align-default" id="id6">
<div class="figure align-default" id="id7">
<img alt="Warp Event Properties" src="../_images/event-warp.png" />
<p class="caption"><span class="caption-text">Warp Event Properties</span><a class="headerlink" href="#id6" title="Permalink to this image"></a></p>
<p class="caption"><span class="caption-text">Warp Event Properties</span><a class="headerlink" href="#id7" title="Permalink to this image"></a></p>
</div>
<dl class="simple">
<dt>Id</dt><dd><p>This is the local id of the warp in the map. This is used when setting the Destination Warp property for another warp.</p>
@ -420,9 +463,9 @@
<div class="section" id="trigger-events">
<h2>Trigger Events<a class="headerlink" href="#trigger-events" title="Permalink to this headline"></a></h2>
<p>Trigger events are scripts that execute when the player walks over them. However, they only execute when a variable is equal some value. Typically, they execute once, set the variables value to something else, and then never execute again because the variables value no longer matches.</p>
<div class="figure align-default" id="id7">
<div class="figure align-default" id="id8">
<img alt="Trigger Event Properties" src="../_images/event-trigger.png" />
<p class="caption"><span class="caption-text">Trigger Event Properties</span><a class="headerlink" href="#id7" title="Permalink to this image"></a></p>
<p class="caption"><span class="caption-text">Trigger Event Properties</span><a class="headerlink" href="#id8" title="Permalink to this image"></a></p>
</div>
<dl class="simple">
<dt>Id</dt><dd><p>The local id of the trigger in the map. This value is not used for anything.</p>
@ -438,9 +481,9 @@
<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 overworlds 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="id8">
<div class="figure align-default" id="id9">
<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="#id8" title="Permalink to this image"></a></p>
<p class="caption"><span class="caption-text">Weather Trigger Event Properties</span><a class="headerlink" href="#id9" title="Permalink to this image"></a></p>
</div>
<dl class="simple">
<dt>Id</dt><dd><p>The local id of the trigger in the map. This value is not used for anything.</p>
@ -452,9 +495,9 @@
<div class="section" id="sign-event">
<h2>Sign Event<a class="headerlink" href="#sign-event" title="Permalink to this headline"></a></h2>
<p>Sign events, or signposts, are simple interactable scripts. They are typically used for things like signs in front of buildings. The players facing direction can be required to be a certain direction in order to interact with the sign. Signs are the first of three “BG” event types.</p>
<div class="figure align-default" id="id9">
<div class="figure align-default" id="id10">
<img alt="Sign Event Properties" src="../_images/event-sign.png" />
<p class="caption"><span class="caption-text">Sign Event Properties</span><a class="headerlink" href="#id9" title="Permalink to this image"></a></p>
<p class="caption"><span class="caption-text">Sign Event Properties</span><a class="headerlink" href="#id10" title="Permalink to this image"></a></p>
</div>
<dl class="simple">
<dt>Id</dt><dd><p>The local id of the BG event in the map. This value is not used for anything.</p>
@ -468,9 +511,9 @@
<div class="section" id="hidden-item-event">
<h2>Hidden Item Event<a class="headerlink" href="#hidden-item-event" title="Permalink to this headline"></a></h2>
<p>Hidden items are invisible items that can be picked up by the player. They each use a flag to ensure the item can only be picked up once.</p>
<div class="figure align-default" id="id10">
<div class="figure align-default" id="id11">
<img alt="Hidden Item Event Properties" src="../_images/event-hidden-item.png" />
<p class="caption"><span class="caption-text">Hidden Item Event Properties</span><a class="headerlink" href="#id10" title="Permalink to this image"></a></p>
<p class="caption"><span class="caption-text">Hidden Item Event Properties</span><a class="headerlink" href="#id11" title="Permalink to this image"></a></p>
</div>
<dl class="simple">
<dt>Id</dt><dd><p>The local id of the BG event in the map. This value is not used for anything.</p>
@ -489,9 +532,9 @@
<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 games 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="id11">
<div class="figure align-default" id="id12">
<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="#id11" title="Permalink to this image"></a></p>
<p class="caption"><span class="caption-text">Secret Base Event Properties</span><a class="headerlink" href="#id12" title="Permalink to this image"></a></p>
</div>
<dl class="simple">
<dt>Id</dt><dd><p>The local id of the BG event in the map. This value is not used for anything.</p>
@ -503,9 +546,9 @@ This event type is unavailable for pokefirered projects; secret bases do not exi
<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 events 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="id12">
<div class="figure align-default" id="id13">
<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="#id12" title="Permalink to this image"></a></p>
<p class="caption"><span class="caption-text">Heal Location Properties</span><a class="headerlink" href="#id13" 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>
@ -528,9 +571,9 @@ A brief description and animation is listed for each of the available tools belo
<dt>Pencil</dt><dd><p>When clicking on an existing event, the pencil tool will behave normally (as the standard cursor). It can also be used to “draw” events in a certain location. The event created will be a default-valued event of the same type as the currently selected event. Right-clicking with the Pencil Tool will return to the Pointer tool.</p>
</dd>
</dl>
<div class="figure align-default" id="id13">
<div class="figure align-default" id="id14">
<img alt="Drawing Object Events with the Pencil Tool" src="../_images/event-tool-pencil.gif" />
<p class="caption"><span class="caption-text">Drawing Object Events with the Pencil Tool</span><a class="headerlink" href="#id13" title="Permalink to this image"></a></p>
<p class="caption"><span class="caption-text">Drawing Object Events with the Pencil Tool</span><a class="headerlink" href="#id14" title="Permalink to this image"></a></p>
</div>
<dl class="simple">
<dt>Pointer</dt><dd><p>The Pointer Tool is the default tool for the event editing tab and allows you to select and move events on the map. The Pointer Tool also gives you access to the <a class="reference internal" href="#ruler-tool"><span class="std std-ref">Ruler Tool</span></a>.</p>
@ -538,17 +581,17 @@ A brief description and animation is listed for each of the available tools belo
<dt>Shift</dt><dd><p>You can use the Shift Tool to move any number of events together. When a selected event is dragged, all other selected events will move with it. When a tile with no event is clicked, all events on the map can be dragged.</p>
</dd>
</dl>
<div class="figure align-default" id="id14">
<div class="figure align-default" id="id15">
<img alt="Moving Events with the Shift Tool" src="../_images/event-tool-shift.gif" />
<p class="caption"><span class="caption-text">Moving Events with the Shift Tool</span><a class="headerlink" href="#id14" title="Permalink to this image"></a></p>
<p class="caption"><span class="caption-text">Moving Events with the Shift Tool</span><a class="headerlink" href="#id15" title="Permalink to this image"></a></p>
</div>
</div>
<div class="section" id="ruler-tool">
<span id="id1"></span><h2>Ruler Tool<a class="headerlink" href="#ruler-tool" title="Permalink to this headline"></a></h2>
<p>The Ruler Tool provides a convenient way to measure distance on the map. This is particularly useful for scripting object movement. With the Pointer Tool selected you can activate the ruler with a Right-click. With the ruler active you can move the mouse around to extend the ruler. The ruler can be deactivated with another Right-click, or locked in place with a Left-click (Left-click again to unlock the ruler).</p>
<div class="figure align-default" id="id15">
<div class="figure align-default" id="id16">
<img alt="Measuring metatile distance with the Ruler Tool" src="../_images/event-tool-ruler.gif" />
<p class="caption"><span class="caption-text">Measuring metatile distance with the Ruler Tool</span><a class="headerlink" href="#id15" title="Permalink to this image"></a></p>
<p class="caption"><span class="caption-text">Measuring metatile distance with the Ruler Tool</span><a class="headerlink" href="#id16" title="Permalink to this image"></a></p>
</div>
</div>
</div>

View file

@ -109,6 +109,7 @@
<li class="toctree-l2"><a class="reference internal" href="#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="#change-map-tilesets">Change Map Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="#undo-redo">Undo &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-collisions.html">Editing Map Collisions</a><ul>
@ -121,6 +122,7 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#clone-object-events">Clone Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
@ -153,7 +155,25 @@
<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="tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#palette-editor">Palette Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
@ -163,6 +183,7 @@
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-header-editing-functions">Map Header Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#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>
@ -185,94 +206,100 @@
<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">4.5.0 - 2021-12-26</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#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#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">4.4.0 - 2020-12-20</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id10">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">4.3.1 - 2020-07-17</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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id14">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id17">4.2.0 - 2020-06-06</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id22">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#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#id21">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id25">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id28">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">3.0.0 - 2020-03-04</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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id30">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id37">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id32">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id33">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id38">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id37">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id38">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id41">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id43">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id45">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id45">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id46">Breaking Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id46">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id47">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id49">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id50">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id54">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id49">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id55">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id54">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id55">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id56">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id57">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id58">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id59">1.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>
@ -456,6 +483,26 @@
<h2>Undo &amp; Redo<a class="headerlink" href="#undo-redo" title="Permalink to this headline"></a></h2>
<p>When painting metatiles, you can undo and redo actions you take. This makes it very easy to fix mistakes or go back in time. Undo can be performed with <code class="docutils literal notranslate"><span class="pre">Ctrl+Z</span></code> or <em>Edit -&gt; Undo</em>. Redo can be performed with <code class="docutils literal notranslate"><span class="pre">Ctrl+Y</span></code> or <em>Edit -&gt; Redo</em>.</p>
</div>
<div class="section" id="prefabs">
<h2>Prefabs<a class="headerlink" href="#prefabs" title="Permalink to this headline"></a></h2>
<p>Prefabs, or “prefabricated selections”, are a way to optimize your map-editing workflow by defining pre-built metatile selections. This can be useful when larger map objects cant be selected from the main metatile selector window. For example, the Poké Mart building is only partially selectable in the metatile selector view.</p>
<div class="figure align-default" id="id16">
<img alt="Prefab Tab" src="../_images/prefab-list.png" />
<p class="caption"><span class="caption-text">Prefab Tab</span><a class="headerlink" href="#id16" title="Permalink to this image"></a></p>
</div>
<p>To create a new prefab, simply select a group of metatiles from the main map view. (See the <a class="reference internal" href="#selecting-metatiles">Selecting Metatiles</a>. section above for how to use right-click-drag to select from the map area.) Then, click the “Create from Selection” button. This will bring up the following window where individual metatiles can be toggled on/off in the prefab. You can also give your prefab a name.</p>
<div class="figure align-default" id="id17">
<img alt="Prefab Creation Window" src="../_images/prefab-create.png" />
<p class="caption"><span class="caption-text">Prefab Creation Window</span><a class="headerlink" href="#id17" title="Permalink to this image"></a></p>
</div>
<p>Prefabs are designated for whichever primary and secondary tilesets were used to create them. As such, any prefabs for with tilesets that are incompatible with the currently-opened map will be hidden from the Prefab list.</p>
<p>To select a prefab to use for painting on the map, simply click on the prefab image in the list view.</p>
<div class="figure align-default" id="id18">
<img alt="Painting with a Prefab" src="../_images/prefab-demo.gif" />
<p class="caption"><span class="caption-text">Painting with a Prefab</span><a class="headerlink" href="#id18" title="Permalink to this image"></a></p>
</div>
<p>Prefab data is saved to a JSON file. It defaults to <code class="docutils literal notranslate"><span class="pre">&lt;project_root&gt;/prefabs.json</span></code>. However, it can be configured in Porymaps project config file.</p>
</div>
</div>

View file

@ -109,6 +109,7 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-collisions.html">Editing Map Collisions</a><ul>
@ -121,6 +122,7 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#clone-object-events">Clone Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
@ -153,7 +155,25 @@
<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="tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#palette-editor">Palette Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
@ -163,6 +183,7 @@
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-header-editing-functions">Map Header Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#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>
@ -185,94 +206,100 @@
<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">4.5.0 - 2021-12-26</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#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#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">4.4.0 - 2020-12-20</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id10">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">4.3.1 - 2020-07-17</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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id14">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id17">4.2.0 - 2020-06-06</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id22">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#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#id21">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id25">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id28">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">3.0.0 - 2020-03-04</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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id30">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id37">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id32">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id33">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id38">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id37">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id38">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id41">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id43">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id45">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id45">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id46">Breaking Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id46">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id47">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id49">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id50">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id54">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id49">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id55">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id54">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id55">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id56">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id57">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id58">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id59">1.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>
@ -391,7 +418,8 @@
</div>
<div class="section" id="tileset-editor">
<h2>Tileset Editor<a class="headerlink" href="#tileset-editor" title="Permalink to this headline"></a></h2>
<p>The Tileset Editor can be opened with <em>File -&gt; Tileset Editor</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl+T</span></code>). When the Tileset Editor is opened, it is opened in the context of the currently-opened map. Every map has a primary and secondary tileset, so you will work with a combination of the two whenever you use the Tileset Editor. The left-side pane shows the primary and secondary tilesets metatiles. The right-side panes allow you to modify the currently-selected metatile.</p>
<p>The Tileset Editor can be opened with <em>File -&gt; Tileset Editor</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl+T</span></code>).
Check out <a class="reference internal" href="tileset-editor.html#tse-ref"><span class="std std-ref">The Tileset Editor</span></a> section for more details.</p>
<div class="figure align-default" id="id4">
<img alt="Tileset Editor" src="../_images/tileset-editor.png" />
<p class="caption"><span class="caption-text">Tileset Editor</span><a class="headerlink" href="#id4" title="Permalink to this image"></a></p>
@ -399,12 +427,14 @@
</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 -&gt; Region Map Editor</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl+M</span></code>). This window will allow you to modify the look and layout of maps on the games 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>
<p>The Region Map Editor can be opened with <em>File -&gt; Region Map Editor</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl+M</span></code>).
This window will allow you to modify the look and layout of maps on the games region map.
Check out <a class="reference internal" href="region-map-editor.html#rme-ref"><span class="std std-ref">The Region Map Editor</span></a> section for more details.</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>
</div>
<p>We covered all of the basic views and windows of Porymap above. Next, lets learn how to use Porymaps features to the fullest when editing map tiles.</p>
<p>We covered all of the basic views and windows of porymap above. Next, lets learn how to use Porymaps features to the fullest when editing map tiles.</p>
</div>
</div>

View file

@ -38,7 +38,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="Scripting Capabilities" href="scripting-capabilities.html" />
<link rel="next" title="The Tileset Editor" href="tileset-editor.html" />
<link rel="prev" title="Creating New Maps" href="creating-new-maps.html" />
</head>
@ -109,6 +109,7 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-collisions.html">Editing Map Collisions</a><ul>
@ -121,6 +122,7 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#clone-object-events">Clone Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
@ -153,7 +155,25 @@
<li class="toctree-l2"><a class="reference internal" href="#background-image-tab">Background Image Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="#map-layout-tab">Map Layout Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="#map-entries-tab">Map Entries Tab</a></li>
<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="tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#palette-editor">Palette Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
@ -163,6 +183,7 @@
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-header-editing-functions">Map Header Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#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>
@ -185,94 +206,100 @@
<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">4.5.0 - 2021-12-26</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#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#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">4.4.0 - 2020-12-20</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id10">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">4.3.1 - 2020-07-17</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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id14">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id17">4.2.0 - 2020-06-06</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id22">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#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#id21">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id25">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id28">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">3.0.0 - 2020-03-04</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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id30">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id37">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id32">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id33">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id38">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id37">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id38">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id41">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id43">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id45">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id45">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id46">Breaking Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id46">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id47">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id49">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id50">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id54">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id49">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id55">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id54">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id55">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id56">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id57">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id58">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id59">1.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>
@ -343,21 +370,113 @@
<div itemprop="articleBody">
<div class="section" id="the-region-map-editor">
<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 -&gt; Region Map Editor</em> from porymaps 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>
<span id="rme-ref"></span><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 maps for your game. You are able to edit the
background tilemap, the layout of map sections, and the array of map section entries
which determines the dimensions of each section.</p>
<p>To open the region map editor, navigate to <em>Tools -&gt; Region Map Editor</em> from
porymaps main window. There is also a keyboard shortcut which is by default <code class="docutils literal notranslate"><span class="pre">Ctrl+M</span></code>.</p>
<p>When you first open the region map editor, you will need to configure porymap to
read your region map data. There are defaults for every base game project available
which should be sufficient for most users.</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>
<p class="caption"><span class="caption-text">Region Map Editor Window</span><a class="headerlink" href="#id4" title="Permalink to this image"></a></p>
<a class="reference internal image-reference" href="../_images/new-configure-window.png"><img alt="RME Window" src="../_images/new-configure-window.png" style="width: 75%;" /></a>
<p class="caption"><span class="caption-text">Region Maps Configurator</span><a class="headerlink" href="#id4" title="Permalink to this image"></a></p>
</div>
<p>This window is split verticallythe region map editing is done at the top,
while the zoomed-in city maps are edited at the bottom. You can use the
sliders to zoom in and out on each of the view panes. You will notice
<p>Porymap supports multiple region maps for any project.
By default, pokeemerald and pokefirered use this feature.
For a more custom region map, you can use the <em>Add Region Map…</em> button to
create a new region map configuration from scratch. You can also double-click on any existing
region map in the list to bring this window up to make changes.</p>
<div class="figure align-center" id="id5">
<a class="reference internal image-reference" href="../_images/rme-config-properties.png"><img alt="RME Config Prop" src="../_images/rme-config-properties.png" style="width: 50%;" /></a>
<p class="caption"><span class="caption-text">Region Map Properties Window</span><a class="headerlink" href="#id5" title="Permalink to this image"></a></p>
</div>
<p>This window has many options for users to define:</p>
<table class="colwidths-given docutils align-default">
<colgroup>
<col style="width: 17%" />
<col style="width: 50%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Field</p></th>
<th class="head"><p>Explanation</p></th>
<th class="head"><p>Restrictions</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>alias</p></td>
<td><p>something for porymap to distinguish between your maps</p></td>
<td><p>unique &amp; valid json string</p></td>
</tr>
<tr class="row-odd"><td><p><strong>Tilemap Properties</strong></p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>format</p></td>
<td><p>format of the tiles</p></td>
<td><p>Plain <em>or</em> 4bpp <em>or</em> 8bpp</p></td>
</tr>
<tr class="row-odd"><td><p>width</p></td>
<td><p>width <em>in tiles</em> of the tilemap</p></td>
<td><p>16 <em>or</em> 32 <em>or</em> 64 <em>or</em> 128</p></td>
</tr>
<tr class="row-even"><td><p>height</p></td>
<td><p>height <em>in tiles</em> of the tilemap</p></td>
<td><p>valid corresponding height based on width</p></td>
</tr>
<tr class="row-odd"><td><p>tileset path</p></td>
<td><p>the relative path to the tile image from project root</p></td>
<td><p>valid filepath string</p></td>
</tr>
<tr class="row-even"><td><p>tilemap path</p></td>
<td><p>the relative path to the tilemap binary from project root</p></td>
<td><p>valid filepath string</p></td>
</tr>
<tr class="row-odd"><td><p>palette path</p></td>
<td><p><em>optional</em> relative path to <code class="docutils literal notranslate"><span class="pre">.pal</span></code> file from project root</p></td>
<td><p>valid filepath string</p></td>
</tr>
<tr class="row-even"><td><p><strong>Layout Properties</strong></p></td>
<td><p><em>can be unchecked for maps without layouts</em></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>format</p></td>
<td><p>the format to read the layout file</p></td>
<td><p>C array <em>or</em> binary</p></td>
</tr>
<tr class="row-even"><td><p>layout path</p></td>
<td><p>the relative path from project root to layout file</p></td>
<td><p>valid filepath string</p></td>
</tr>
<tr class="row-odd"><td><p>width</p></td>
<td><p>the width of the layout</p></td>
<td><p>non-negative integer</p></td>
</tr>
<tr class="row-even"><td><p>left offset</p></td>
<td><p>the position on the tilemap which defines layout x=0</p></td>
<td><p>width + left offset &lt; tilemap width</p></td>
</tr>
<tr class="row-odd"><td><p>height</p></td>
<td><p>the height of the layout</p></td>
<td><p>non-negative integer</p></td>
</tr>
<tr class="row-even"><td><p>top offset</p></td>
<td><p>the position on the tilemap which defines layout y=0</p></td>
<td><p>height + top offset &lt; tilemap height</p></td>
</tr>
</tbody>
</table>
<p>When you are finished configuring your region maps, you can select <em>OK</em>. This will
display the main editor window.</p>
<div class="figure align-center" id="id6">
<a class="reference internal image-reference" href="../_images/rme-main-window.png"><img alt="RME Config Prop" src="../_images/rme-main-window.png" style="width: 75%;" /></a>
<p class="caption"><span class="caption-text">Region Map Editor Window</span><a class="headerlink" href="#id6" title="Permalink to this image"></a></p>
</div>
<p>This window has a combobox labeled “Region” which you can use to select the current
region map you want to edit.</p>
<p>You will notice
that there are three different tabs above the image of the region map
(<a class="reference internal" href="#background-image-tab"><span class="std std-ref">Background Image</span></a>,
<a class="reference internal" href="#map-layout-tab"><span class="std std-ref">Map Layout</span></a>,
@ -371,59 +490,39 @@ to paint the selected tile onto the region map image. If you make a mistake, or
are unhappy with what you have done, you can undo (<code class="docutils literal notranslate"><span class="pre">Ctrl+Z</span></code> or <em>Edit -&gt; Undo</em>)
and redo (<code class="docutils literal notranslate"><span class="pre">Ctrl+Y</span></code> or <em>Edit -&gt; Redo</em>) your changes. Right-clicking on the map
image will select the tile under your mouse from the tile selector.</p>
<p>If your tilemap format is not “Plain”, then you can also select the palette,
h-flip, and v-flip of any tile you are painting with.</p>
<p>If you want to clear the background image, <em>Edit -&gt; Clear Background Image</em>
will set all tiles to the first tile in the tile selector.</p>
<div class="figure align-center" id="id5">
<a class="reference internal image-reference" href="../_images/rme-painting-image.gif"><img alt="RME Paint" src="../_images/rme-painting-image.gif" style="width: 730.5px; height: 424.5px;" /></a>
<p class="caption"><span class="caption-text">Drawing on the Region Map Image</span><a class="headerlink" href="#id5" title="Permalink to this image"></a></p>
</div>
<p>It is likely that you will want to use your own tiles for your region map. You
can import a tile image by navigating to <em>Tools -&gt; Import Region Map Image Tiles</em>.
There are strict requirements for your region map tile image. It must (1) be
indexed with a 256 color palette*, (2) be composed of 8x8 pixel tiles, (3) have 256
or fewer tiles.</p>
<p>* While the region map tile image requires a 256-color palette, the image only
uses the 32 colors beginning at index 112 in the palette.</p>
<p>You can use the sliders to zoom in and out on each of the view panes.</p>
</div>
<div class="section" id="map-layout-tab">
<span id="id2"></span><h2>Map Layout Tab<a class="headerlink" href="#map-layout-tab" title="Permalink to this headline"></a></h2>
<p>The layout tab is where map sections are placed on the region map. When the
player looks at the region map in-game, the layout determines the map under the
cursor.</p>
<div class="figure align-center" id="id6">
<a class="reference internal image-reference" href="../_images/rme-layout-tab.png"><img alt="RME Layout" src="../_images/rme-layout-tab.png" style="width: 734.25px; height: 429.75px;" /></a>
<p class="caption"><span class="caption-text">RME Layout Tab</span><a class="headerlink" href="#id6" title="Permalink to this image"></a></p>
<div class="figure align-center" id="id7">
<a class="reference internal image-reference" href="../_images/rme-new-layout-tab.png"><img alt="RME Layout" src="../_images/rme-new-layout-tab.png" style="width: 75%;" /></a>
<p class="caption"><span class="caption-text">RME Layout Tab</span><a class="headerlink" href="#id7" title="Permalink to this image"></a></p>
</div>
<p>To modify the region map layout, select a position by clicking on the map image
and higlighting a single square. The “Map Section” combobox will be populated
with all of the map sections defined in <code class="docutils literal notranslate"><span class="pre">include/constants/region_map_sections.h</span></code>.
Select the map section you want to associate with the selected position on the
region map. To change the popup name of the map section when you enter the map,
type it into the “Map Name” box. The popup name is tied to the map section, so
each layout square with the same map section will share a name.</p>
<p>If you want to start from a blank layout, <em>Edit -&gt; Clear Map Layout</em> will set
all layout squares to the value of <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code>.</p>
<p>When adding new region map sections, the layout will be affected. This is
because the layout is stored as a binary file and uses the raw value of each
map section. In order to fix your layout to account for this, you can swap two
values for the entire layout with <em>Edit -&gt; Swap</em>.</p>
<p>In this example, <code class="docutils literal notranslate"><span class="pre">MAPSEC_NEW_MAPSEC</span></code> is inserted before <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code>, and
therefore the layout will link the original value of <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code> to the new
map section <code class="docutils literal notranslate"><span class="pre">MAPSEC_NEW_MAPSEC</span></code>. Instances of <code class="docutils literal notranslate"><span class="pre">MAPSEC_NEW_MAPSEC</span></code> are swapped
with <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code>.</p>
<div class="figure align-center" id="id7">
<a class="reference internal image-reference" href="../_images/rme-layout-swap.gif"><img alt="RME Swap" src="../_images/rme-layout-swap.gif" style="width: 559.5px; height: 495.0px;" /></a>
<p class="caption"><span class="caption-text">Swapping Map Sections</span><a class="headerlink" href="#id7" title="Permalink to this image"></a></p>
</div>
region map.</p>
<p>There are a couple of tools which make editing multiple layout squares simultaneously easier.</p>
<p><em>Edit -&gt; Clear Map Layout</em> will set all squares in the layout to <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code>.</p>
<p><em>Edit -&gt; Swap Layout Sections…</em> will exchange two layout sections with each other.</p>
<p><em>Edit -&gt; Replace Layout Section…</em> will replace all instances of one section with another.</p>
<p>The “Delete Square” button simply resets a single layout square to <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code>.</p>
</div>
<div class="section" id="map-entries-tab">
<span id="id3"></span><h2>Map Entries Tab<a class="headerlink" href="#map-entries-tab" title="Permalink to this headline"></a></h2>
<p>A region map entry is the area on the region map that spans an entire map section.
This determines, for example, where the players head appears on the region map
in-game. Entries are stored at <code class="docutils literal notranslate"><span class="pre">src/data/region_map/region_map_entries.h</span></code>.</p>
in-game. Entries are stored in <code class="docutils literal notranslate"><span class="pre">src/data/region_map/region_map_sections.json</span></code>.</p>
<div class="figure align-center" id="id8">
<a class="reference internal image-reference" href="../_images/rme-entries-tab.png"><img alt="RME Entries" src="../_images/rme-entries-tab.png" style="width: 734.25px; height: 429.75px;" /></a>
<a class="reference internal image-reference" href="../_images/rme-new-entries-tab.png"><img alt="RME Entries" src="../_images/rme-new-entries-tab.png" style="width: 75%;" /></a>
<p class="caption"><span class="caption-text">RME Entries Tab</span><a class="headerlink" href="#id8" title="Permalink to this image"></a></p>
</div>
<p>To edit an entry, select a map section from the “Map Section” combobox. You can
@ -431,21 +530,8 @@ use the “Location” “x” and “y” spinboxes to change the coordinates o
You can also drag the entry around the map. The “x” and “y” values correspond to
the position of the entrys top-left square on the region map. The “Dimensions”
“width” and “height” spinboxes will change the size of the map entry.</p>
</div>
<div class="section" id="city-maps">
<h2>City Maps<a class="headerlink" href="#city-maps" title="Permalink to this headline"></a></h2>
<p>In the bottom half of the region map editor window, city maps can be edited.
You paint on this the same way you paint on the region map background image.</p>
<div class="figure align-center" id="id9">
<a class="reference internal image-reference" href="../_images/rme-painting-city.gif"><img alt="City Paint" src="../_images/rme-painting-city.gif" style="width: 482.4px; height: 408.0px;" /></a>
<p class="caption"><span class="caption-text">Drawing on the City Map</span><a class="headerlink" href="#id9" title="Permalink to this image"></a></p>
</div>
<p>To use custom tiles, there is a tile image importer under
<em>Tools -&gt; Import City Map Image Tiles</em>. These images must (1) be indexed with a
16 color palette, (2) be made up of 8x8 pixel tiles, (3) have 256 or fewer tiles.</p>
<p>You can add a new city map by pressing the <img alt="new-city-map-button" src="../_images/rme-new-city-map-button.png" /> button.</p>
<p>Currently, it is not possible to associate a city map to a region map location,
but that functionality will be added in a future update.</p>
<p>To change the popup name of the map section when you enter the map, type it
into the “Map Name” box.</p>
</div>
</div>
@ -457,7 +543,7 @@ but that functionality will be added in a future update.</p>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<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="tileset-editor.html" class="btn btn-neutral float-right" title="The Tileset 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-left" title="Creating New Maps" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

File diff suppressed because it is too large Load diff

View file

@ -109,6 +109,7 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-collisions.html">Editing Map Collisions</a><ul>
@ -121,6 +122,7 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#clone-object-events">Clone Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
@ -153,7 +155,25 @@
<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="tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#palette-editor">Palette Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
@ -163,6 +183,7 @@
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-header-editing-functions">Map Header Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#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>
@ -185,94 +206,100 @@
<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">4.5.0 - 2021-12-26</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#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#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">4.4.0 - 2020-12-20</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id10">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">4.3.1 - 2020-07-17</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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id14">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id17">4.2.0 - 2020-06-06</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id22">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#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#id21">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id25">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id28">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">3.0.0 - 2020-03-04</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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id30">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id37">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id32">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id33">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id38">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id37">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id38">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id41">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id43">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id45">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id45">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id46">Breaking Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id46">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id47">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id49">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id50">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id54">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id49">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id55">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id54">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id55">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id56">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id57">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id58">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id59">1.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>
@ -373,138 +400,150 @@ determined by this file.</p>
<td><p>yes</p></td>
<td><p>The project that will be opened on launch</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">recent_map</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">reopen_on_launch</span></code></p></td>
<td><p>1</p></td>
<td><p>global</p></td>
<td><p>yes</p></td>
<td><p>Whether the most recent project should be opened on launch</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">recent_map</span></code></p></td>
<td></td>
<td><p>global</p></td>
<td><p>yes</p></td>
<td><p>The map that will be opened on launch</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">pretty_cursors</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">pretty_cursors</span></code></p></td>
<td><p>1</p></td>
<td><p>global</p></td>
<td><p>yes</p></td>
<td><p>Whether to use custom crosshair cursors</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">map_sort_order</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">map_sort_order</span></code></p></td>
<td><p>group</p></td>
<td><p>global</p></td>
<td><p>yes</p></td>
<td><p>The order map list is sorted in</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">window_geometry</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">window_geometry</span></code></p></td>
<td></td>
<td><p>global</p></td>
<td><p>no</p></td>
<td><p>For restoring window sizes</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">window_state</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">window_state</span></code></p></td>
<td></td>
<td><p>global</p></td>
<td><p>no</p></td>
<td><p>For restoring window sizes</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">map_splitter_state</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">map_splitter_state</span></code></p></td>
<td></td>
<td><p>global</p></td>
<td><p>no</p></td>
<td><p>For restoring window sizes</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">main_splitter_state</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">main_splitter_state</span></code></p></td>
<td></td>
<td><p>global</p></td>
<td><p>no</p></td>
<td><p>For restoring window sizes</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">collision_opacity</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">collision_opacity</span></code></p></td>
<td><p>50</p></td>
<td><p>global</p></td>
<td><p>yes</p></td>
<td><p>Opacity of collision overlay</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">metatiles_zoom</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">metatiles_zoom</span></code></p></td>
<td><p>30</p></td>
<td><p>global</p></td>
<td><p>yes</p></td>
<td><p>Scale of map metatiles</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">show_player_view</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">show_player_view</span></code></p></td>
<td><p>0</p></td>
<td><p>global</p></td>
<td><p>yes</p></td>
<td><p>Display a rectangle for the GBA screen radius</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">show_cursor_tile</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">show_cursor_tile</span></code></p></td>
<td><p>0</p></td>
<td><p>global</p></td>
<td><p>yes</p></td>
<td><p>Display a rectangle around the hovered metatile(s)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">monitor_files</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">monitor_files</span></code></p></td>
<td><p>1</p></td>
<td><p>global</p></td>
<td><p>yes</p></td>
<td><p>Whether porymap will monitor changes to project files</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">region_map_dimensions</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">region_map_dimensions</span></code></p></td>
<td><p>32x20</p></td>
<td><p>global</p></td>
<td><p>yes</p></td>
<td><p>The dimensions of the region map tilemap</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">theme</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">theme</span></code></p></td>
<td><p>default</p></td>
<td><p>global</p></td>
<td><p>yes</p></td>
<td><p>The color theme for porymap windows and widgets</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">text_editor_goto_line</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">text_editor_goto_line</span></code></p></td>
<td></td>
<td><p>global</p></td>
<td><p>yes</p></td>
<td><p>The command that will be executed when clicking the button next the <code class="docutils literal notranslate"><span class="pre">Script</span></code> combo-box.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">text_editor_open_directory</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">text_editor_open_directory</span></code></p></td>
<td></td>
<td><p>global</p></td>
<td><p>yes</p></td>
<td><p>The command that will be executed when clicking <code class="docutils literal notranslate"><span class="pre">Open</span> <span class="pre">Project</span> <span class="pre">in</span> <span class="pre">Text</span> <span class="pre">Editor</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">base_game_version</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">base_game_version</span></code></p></td>
<td></td>
<td><p>project</p></td>
<td><p>no</p></td>
<td><p>The base pret repo for this project</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">use_encounter_json</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">use_encounter_json</span></code></p></td>
<td><p>1</p></td>
<td><p>project</p></td>
<td><p>yes</p></td>
<td><p>Enables wild encounter table editing</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">use_poryscript</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">use_poryscript</span></code></p></td>
<td><p>0</p></td>
<td><p>project</p></td>
<td><p>yes</p></td>
<td><p>Whether to open .pory files for scripts</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">use_custom_border_size</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">use_custom_border_size</span></code></p></td>
<td><p>0</p></td>
<td><p>project</p></td>
<td><p>yes</p></td>
<td><p>Whether to allow variable border sizes</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">enable_event_weather_trigger</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">enable_event_weather_trigger</span></code></p></td>
<td><p>1 if not <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code></p></td>
<td><p>project</p></td>
<td><p>yes</p></td>
<td><p>Allows adding Weather Trigger events</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">enable_event_secret_base</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">enable_event_secret_base</span></code></p></td>
<td><p>1 if not <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code></p></td>
<td><p>project</p></td>
<td><p>yes</p></td>
<td><p>Allows adding Secret Base events</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">enable_event_clone_object</span></code></p></td>
<td><p>1 if <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code></p></td>
<td><p>project</p></td>
<td><p>yes</p></td>
<td><p>Allows adding Clone Object events</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">enable_hidden_item_quantity</span></code></p></td>
<td><p>1 if <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code></p></td>
<td><p>project</p></td>
@ -523,36 +562,36 @@ determined by this file.</p>
<td><p>yes</p></td>
<td><p>Adds <code class="docutils literal notranslate"><span class="pre">Respawn</span> <span class="pre">Map</span></code> and <code class="docutils literal notranslate"><span class="pre">Respawn</span> <span class="pre">NPC</span></code> to Heal Location events</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">enable_object_event_in_connection</span></code></p></td>
<td><p>1 if <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code></p></td>
<td><p>project</p></td>
<td><p>yes</p></td>
<td><p>Adds <code class="docutils literal notranslate"><span class="pre">In</span> <span class="pre">Connection</span></code> to Object events</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">enable_floor_number</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">enable_floor_number</span></code></p></td>
<td><p>1 if <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code></p></td>
<td><p>project</p></td>
<td><p>yes</p></td>
<td><p>Adds <code class="docutils literal notranslate"><span class="pre">Floor</span> <span class="pre">Number</span></code> to map headers</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">create_map_text_file</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">create_map_text_file</span></code></p></td>
<td><p>1 if not <code class="docutils literal notranslate"><span class="pre">pokeemerald</span></code></p></td>
<td><p>project</p></td>
<td><p>yes</p></td>
<td><p>A <code class="docutils literal notranslate"><span class="pre">text.inc</span></code> or <code class="docutils literal notranslate"><span class="pre">text.pory</span></code> file will be created for any new map</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">enable_triple_layer_metatiles</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">enable_triple_layer_metatiles</span></code></p></td>
<td><p>0</p></td>
<td><p>project</p></td>
<td><p>yes</p></td>
<td><p>Enables triple-layer metatiles (See <a class="reference external" href="https://github.com/pret/pokeemerald/wiki/Triple-layer-metatiles">https://github.com/pret/pokeemerald/wiki/Triple-layer-metatiles</a>)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">custom_scripts</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">custom_scripts</span></code></p></td>
<td></td>
<td><p>project</p></td>
<td><p>yes</p></td>
<td><p>A list of script files to load into the scripting engine</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">prefabs_filepath</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">&lt;project_root&gt;/prefabs.json</span></code></p></td>
<td><p>project</p></td>
<td><p>yes</p></td>
<td><p>The filepath containing prefab JSON data</p></td>
</tr>
</tbody>
</table>
<p>Some of these settings can be toggled manually in porymap via the <em>Options</em> menu.</p>

View file

@ -109,6 +109,7 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-collisions.html">Editing Map Collisions</a><ul>
@ -121,6 +122,7 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#clone-object-events">Clone Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
@ -153,7 +155,25 @@
<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="tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#palette-editor">Palette Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
@ -163,6 +183,7 @@
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-header-editing-functions">Map Header Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#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>
@ -185,94 +206,100 @@
<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">4.5.0 - 2021-12-26</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#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#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">4.4.0 - 2020-12-20</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id10">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">4.3.1 - 2020-07-17</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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id14">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id17">4.2.0 - 2020-06-06</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id22">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#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#id21">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id25">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id28">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">3.0.0 - 2020-03-04</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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id30">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id37">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id32">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id33">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id38">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id37">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id38">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id41">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id43">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id45">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id45">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id46">Breaking Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id46">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id47">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id49">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id50">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id54">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id49">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id55">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id54">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id55">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id56">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id57">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id58">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id59">1.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>

View file

@ -0,0 +1,541 @@
<!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>The Tileset Editor &mdash; porymap documentation</title>
<link rel="shortcut icon" href="../_static/porymap-icon-2.ico"/>
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script 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="Scripting Capabilities" href="scripting-capabilities.html" />
<link rel="prev" title="The Region Map Editor" href="region-map-editor.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
<a href="../index.html" class="icon icon-home"> porymap
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">User Manual</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#about-porymap">About Porymap</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#getting-started">Getting Started</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="navigation.html">Navigation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="navigation.html#map-list">Map List</a></li>
<li class="toctree-l2"><a class="reference internal" href="navigation.html#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="navigation.html#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="navigation.html#region-map-editor">Region Map Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-tiles.html">Editing Map Tiles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#visual-options">Visual Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#selecting-metatiles">Selecting Metatiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pencil-tool">Pencil Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pointer-tool">Pointer Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#bucket-fill-tool">Bucket Fill Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#map-shift-tool">Map Shift Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#smart-paths">Smart Paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#straight-paths">Straight Paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-collisions.html">Editing Map Collisions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#selecting-collision-types">Selecting Collision Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#painting-collisions">Painting Collisions</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#collision-types">Collision Types</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#clone-object-events">Clone Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#sign-event">Sign Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#secret-base-event">Secret Base Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#ruler-tool">Ruler Tool</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-connections.html">Editing Map Connections</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#follow-connections">Follow Connections</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-wild-encounters.html">Editing Wild Encounters</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#adding-new-encounter-groups">Adding New Encounter Groups</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a><ul>
<li class="toctree-l2"><a class="reference internal" href="creating-new-maps.html#new-map-options">New Map Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-entries-tab">Map Entries Tab</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
<li class="toctree-l3"><a class="reference internal" href="#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#palette-editor">Palette Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#scripting-api">Scripting API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-header-editing-functions">Map Header Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#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>
<li class="toctree-l1"><a class="reference internal" href="shortcuts.html">Shortcuts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#region-map-editor">Region Map Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a></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#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#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">4.4.0 - 2020-12-20</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">4.3.1 - 2020-07-17</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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id17">4.2.0 - 2020-06-06</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id25">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id28">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id30">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id32">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id33">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id37">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id38">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id41">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id43">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id45">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id46">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id47">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id49">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id54">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id55">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id56">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id57">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id58">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id59">1.0.0 - 2018-10-26</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">porymap</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> &raquo;</li>
<li>The Tileset Editor</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/manual/tileset-editor.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="the-tileset-editor">
<span id="tse-ref"></span><h1>The Tileset Editor<a class="headerlink" href="#the-tileset-editor" title="Permalink to this headline"></a></h1>
<p>Here, you can edit individual tilesets.
When the Tileset Editor is opened, it is opened in the context of the
currently-opened map. Every map has a primary and secondary tileset, so you
will work with a combination of the two whenever you use the Tileset Editor.
The left-side pane shows the primary and secondary tilesets metatiles.
The right-side panes allow you to modify the currently-selected metatile.</p>
<div class="figure align-center" id="id1">
<a class="reference internal image-reference" href="../_images/tse-open-window.png"><img alt="TSE Window" src="../_images/tse-open-window.png" style="width: 75%;" /></a>
<p class="caption"><span class="caption-text">Tileset Editor Window</span><a class="headerlink" href="#id1" title="Permalink to this image"></a></p>
</div>
<div class="section" id="metatile-properties">
<h2>Metatile Properties<a class="headerlink" href="#metatile-properties" title="Permalink to this headline"></a></h2>
<div class="figure align-center" id="id2">
<a class="reference internal image-reference" href="../_images/tse-metatile-properties.png"><img alt="MP Frame" src="../_images/tse-metatile-properties.png" style="width: 30%;" /></a>
<p class="caption"><span class="caption-text">Metatile Properties Panel</span><a class="headerlink" href="#id2" title="Permalink to this image"></a></p>
</div>
<div class="section" id="layer-type">
<h3>Layer Type<a class="headerlink" href="#layer-type" title="Permalink to this headline"></a></h3>
<p>Defines the background layers the metatiles will use for drawing.
The options are:</p>
<p><strong>Normal</strong> — Metatile uses middle and top bg layers</p>
<p><strong>Covered</strong> — Metatile uses bottom and middle bg layers</p>
<p><strong>Split</strong> — Metatile uses bottom and top bg layers</p>
</div>
<div class="section" id="metatile-behavior">
<h3>Metatile Behavior<a class="headerlink" href="#metatile-behavior" title="Permalink to this headline"></a></h3>
<p>Defines the metatile behavior associated with this metatile. This can be used
for a variety of different reasons. For example, warps, ice, and tall grass effects
are all determined by a metatiles behavior.</p>
<p>This dropdown is populated with constants found in <code class="docutils literal notranslate"><span class="pre">include/constants/metatile_behaviors.h</span></code>.</p>
</div>
<div class="section" id="encounter-type">
<h3>Encounter Type<a class="headerlink" href="#encounter-type" title="Permalink to this headline"></a></h3>
<blockquote>
<div><p><em>pokefirered exclusive</em></p>
</div></blockquote>
<p>Used to determine which category of wild encounter to attempt.</p>
</div>
<div class="section" id="terrain-type">
<h3>Terrain Type<a class="headerlink" href="#terrain-type" title="Permalink to this headline"></a></h3>
<blockquote>
<div><p><em>pokefirered exclusive</em></p>
</div></blockquote>
<p>Used to determine certain attributes of metatiles. Can be useful in certain scenarios.
For example, to determine if the player is facing water or standing in grass.</p>
</div>
<div class="section" id="metatile-label">
<h3>Metatile Label<a class="headerlink" href="#metatile-label" title="Permalink to this headline"></a></h3>
<blockquote>
<div><p><em>optional</em></p>
</div></blockquote>
<p>A name can be given to metatiles so that they may be referenced in source code.
These are defined in <code class="docutils literal notranslate"><span class="pre">include/constants/metatile_labels.h</span></code> and can be used in
together with the <code class="docutils literal notranslate"><span class="pre">METATILE_ID</span></code> macro.</p>
<p>For example, the metatile pictured above can be accessed like
<code class="docutils literal notranslate"><span class="pre">METATILE_ID(General,</span> <span class="pre">Plain_Grass)</span></code>.</p>
</div>
</div>
<div class="section" id="tools-menu">
<h2>Tools Menu<a class="headerlink" href="#tools-menu" title="Permalink to this headline"></a></h2>
<p>The tileset editor provides users with several useful tools for making edits
easier and more convenient.</p>
<div class="section" id="import-tiles-image">
<h3>Import Tiles Image…<a class="headerlink" href="#import-tiles-image" title="Permalink to this headline"></a></h3>
<p>Tool to automatically import a new tile image for a tileset.
The tile image is an indexed png of 8x8 pixel tiles, which are used to form
metatiles in the tileset editor.</p>
</div>
<div class="section" id="import-metatiles-from-advance-map-1-92">
<h3>Import Metatiles from Advance Map 1.92…<a class="headerlink" href="#import-metatiles-from-advance-map-1-92" title="Permalink to this headline"></a></h3>
<p>Helpful for users converting projects from binary hacks.
Metatile data exported from Advance Map 1.92 in a <code class="docutils literal notranslate"><span class="pre">.bvd`</span></code> file can be imported
into porymaps tileset editor.
This saves a lot of time since metatiles will not have to be defined from scratch.</p>
</div>
<div class="section" id="change-number-of-metatiles">
<h3>Change Number of Metatiles<a class="headerlink" href="#change-number-of-metatiles" title="Permalink to this headline"></a></h3>
<p>The number of metatiles in both the current primary and current secondary tileset
can be adjusted within the limits.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>You may need to change the Makefile rules for the number of tiles allowed
for the tileset in the file <code class="docutils literal notranslate"><span class="pre">graphics_file_rules.mk</span></code>. You can simply
remove the <code class="docutils literal notranslate"><span class="pre">-num_tiles=</span></code> argument altogether.</p>
</div>
</div>
<div class="section" id="other-tools">
<h3>Other Tools<a class="headerlink" href="#other-tools" title="Permalink to this headline"></a></h3>
<div class="figure align-center" id="id3">
<a class="reference internal image-reference" href="../_images/tse-display-tool.png"><img alt="TSE Unused" src="../_images/tse-display-tool.png" style="width: 60%;" /></a>
<p class="caption"><span class="caption-text">Displaying Unused Tiles</span><a class="headerlink" href="#id3" title="Permalink to this image"></a></p>
</div>
<p>There are also tools to count the number of metatile and tile usages across the
entire project, which can be useful, for example, in determining whether a
metatile can be deleted. The output of these operations is pictured above.</p>
</div>
</div>
<div class="section" id="palette-editor">
<h2>Palette Editor<a class="headerlink" href="#palette-editor" title="Permalink to this headline"></a></h2>
<p>The palette editor is where the <code class="docutils literal notranslate"><span class="pre">.pal</span></code> files are modified for each tileset.</p>
<div class="figure align-center" id="id4">
<a class="reference internal image-reference" href="../_images/pe-open-window.png"><img alt="PE" src="../_images/pe-open-window.png" style="width: 75%;" /></a>
<p class="caption"><span class="caption-text">Palette Editor</span><a class="headerlink" href="#id4" title="Permalink to this image"></a></p>
</div>
<p>The current palette is indicated by the spinner at the top left. To switch
between palettes, just change the spinner value.
At the top right is a setting for the bit depth at which colors are displayed.
The colors in a palette file are displayed as 24 bit numbers, but the GBA
hardware only allows 15 bit colors, so displaying in 15 bits can be more realistic.</p>
<p>Each individual color can be adjusted with either the sliders or the spinners,
in addition to the hex value box. Each color also has an eyedropper toolbutton
which allows users to pick any color from the screen and add it to the palette.</p>
<p>Entire palettes can also be imported from a variety of formats,
including JASC, Adobe Color Table, Tile Layer Pro, and Advance PE.
Each imported palette must contain 16 colors.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<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="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>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; 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>

Binary file not shown.

View file

@ -109,6 +109,7 @@
<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 &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-collisions.html">Editing Map Collisions</a><ul>
@ -121,6 +122,7 @@
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#object-events">Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#clone-object-events">Clone Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
@ -153,7 +155,25 @@
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#map-entries-tab">Map Entries Tab</a></li>
<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/tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../manual/tileset-editor.html#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/tileset-editor.html#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/tileset-editor.html#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/tileset-editor.html#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../manual/tileset-editor.html#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../manual/tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/tileset-editor.html#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../manual/tileset-editor.html#palette-editor">Palette Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
@ -163,6 +183,7 @@
<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-header-editing-functions">Map Header 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>
@ -185,94 +206,100 @@
<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">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#unreleased">Unreleased</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="#changed">Changed</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">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id3">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id5">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id1">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id3">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id6">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id7">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id8">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id9">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id5">4.4.0 - 2020-12-20</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id10">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id11">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id12">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id13">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id9">4.3.1 - 2020-07-17</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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id14">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id15">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id16">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id17">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id13">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id14">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id15">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id16">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id18">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id19">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id20">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id21">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id17">4.2.0 - 2020-06-06</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id22">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="#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="#id21">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id22">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id23">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id24">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id26">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id27">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id25">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id26">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id27">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id28">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id29">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id28">3.0.0 - 2020-03-04</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>
<li class="toctree-l2"><a class="reference internal" href="#id30">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id31">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id33">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id34">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id35">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id36">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id37">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id32">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id33">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id34">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id35">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id36">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id38">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id37">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id38">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id41">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id42">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id42">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id43">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id44">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id44">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id45">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id45">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id46">Breaking Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id46">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id47">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id48">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id49">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id50">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id51">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id52">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id53">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id54">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id49">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id55">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id54">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id55">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id56">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id57">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id58">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id59">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>
@ -350,13 +377,56 @@ and this project somewhat adheres to <a class="reference external" href="https:/
<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><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.5.0...HEAD">Unreleased</a><a class="headerlink" href="#unreleased" title="Permalink to this headline"></a></h2>
<p>Nothing, yet.</p>
<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>Proper support for pokefirereds clone objects was added, which requires the changes made in <a class="reference external" href="https://github.com/pret/pokefirered/pull/484">pokefirered/#484</a>.</p></li>
</ul>
</div>
<div class="section" id="id1">
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.4.0...4.4.0">4.5.0</a> - 2021-12-26<a class="headerlink" href="#id1" 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 Copy/Paste for metatiles in the Tileset Editor.</p></li>
<li><p>Add new features to the scripting API, including the ability to display message boxes and user input windows, set overlay opacity, get/set map header properties, read tile pixel data, and set blocks or metatile attributes using a raw value.</p></li>
<li><p>Add button to copy the full metatile label to the clipboard in the Tileset Editor.</p></li>
<li><p>Add option to not open the most recent project on launch.</p></li>
<li><p>Add color picker to palette editor for taking colors from the screen.</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>Overhauled the region map editor, adding support for tilemaps, and significant customization. Also now supports pokefirered.</p></li>
<li><p>If an object event is inanimate, it will always render using its first frame.</p></li>
<li><p>Only log “Unknown custom script function” when a registered script function is not present in any script.</p></li>
<li><p>Unused metatile attribute bits that are set are preserved instead of being cleared.</p></li>
<li><p>The wild encounter editor is automatically disabled if the encounter JSON data cannot be read</p></li>
<li><p>Metatiles are always rendered accurately with 3 layers, and the unused layer is not assumed to be transparent.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">object_event_graphics_info.h</span></code> can now be parsed correctly if it uses structs with attributes.</p></li>
<li><p>The selection is no longer reset when pasting events. The newly pasted events are selected instead.</p></li>
<li><p>Palette editor ui is updated a bit to allow hex and rgb value input.</p></li>
</ul>
</div>
<div class="section" id="fixed">
<h3>Fixed<a class="headerlink" href="#fixed" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Fix cursor tile outline not updating at the end of a dragged selection.</p></li>
<li><p>Fix cursor tile and player view outlines exiting map bounds while painting.</p></li>
<li><p>Fix cursor tile and player view outlines not updating immediately when toggled in Collision view.</p></li>
<li><p>Fix selected space not updating while painting in Collision view.</p></li>
<li><p>Fix collision values of 2 or 3 not rendering properly.</p></li>
<li><p>Fix the map music dropdown being empty when importing a map from Advance Map.</p></li>
<li><p>Fix object events added by pasting ignoring the map event limit.</p></li>
<li><p>Fixed a bug where saving the tileset editor would reselect the main editors first selected metatile.</p></li>
<li><p>Fix crashes / unexpected behavior if certain scripting API functions are given invalid palette or tile numbers.</p></li>
</ul>
</div>
</div>
<div class="section" id="id1">
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.4.0...4.5.0">4.5.0</a> - 2021-12-26<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
<div class="section" id="id2">
<h3>Added<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>WSL project paths are now supported. (For example, \wsl$\Ubuntu-20.04\home\huderlem\pokeemerald)</p></li>
<li><p>Add ability to export map timelapse animated GIFs with <code class="docutils literal notranslate"><span class="pre">File</span> <span class="pre">-&gt;</span> <span class="pre">Export</span> <span class="pre">Map</span> <span class="pre">Timelapse</span> <span class="pre">Image...</span></code>.</p></li>
<li><p>Add tool to count the times each metatile or tile is used in the tileset editor.</p></li>
@ -367,8 +437,8 @@ and this project somewhat adheres to <a class="reference external" href="https:/
<li><p>Porymap is now compatible with Qt6.</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="id3">
<h3>Changed<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>New events will be placed in the center of the current view of the map.</p></li>
<li><p>Scripting API errors are more detailed and logged in more situations.</p></li>
@ -377,8 +447,8 @@ and this project somewhat adheres to <a class="reference external" href="https:/
<li><p>The onBlockChanged script callback is now called for blocks changed by Undo/Redo.</p></li>
</ul>
</div>
<div class="section" id="fixed">
<h3>Fixed<a class="headerlink" href="#fixed" title="Permalink to this headline"></a></h3>
<div class="section" id="id4">
<h3>Fixed<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Fix % operator in C defines not being evaluated</p></li>
<li><p>Fix tileset palette editor crash that could occur when switching maps or tilesets with it open.</p></li>
@ -388,10 +458,10 @@ and this project somewhat adheres to <a class="reference external" href="https:/
</ul>
</div>
</div>
<div class="section" id="id2">
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.3.1...4.4.0">4.4.0</a> - 2020-12-20<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
<div class="section" id="id3">
<h3>Added<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<div class="section" id="id5">
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.3.1...4.4.0">4.4.0</a> - 2020-12-20<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h2>
<div class="section" id="id6">
<h3>Added<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Add undoable edit history for Events tab.</p></li>
<li><p>Add keyboard shortcut for <code class="docutils literal notranslate"><span class="pre">DEL</span></code> key to delete the currently selected event(s).</p></li>
@ -407,14 +477,14 @@ and this project somewhat adheres to <a class="reference external" href="https:/
<li><p>Add custom text editor commands in <code class="docutils literal notranslate"><span class="pre">Options</span> <span class="pre">-&gt;</span> <span class="pre">Edit</span> <span class="pre">Preferences</span></code>, a tool-button next to the <code class="docutils literal notranslate"><span class="pre">Script</span></code> combo-box, and <code class="docutils literal notranslate"><span class="pre">Tools</span> <span class="pre">-&gt;</span> <span class="pre">Open</span> <span class="pre">Project</span> <span class="pre">in</span> <span class="pre">Text</span> <span class="pre">Editor</span></code>. The tool-button will open the containing file to the cooresponding script.</p></li>
</ul>
</div>
<div class="section" id="id4">
<h3>Changed<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<div class="section" id="id7">
<h3>Changed<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Holding <code class="docutils literal notranslate"><span class="pre">shift</span></code> now toggles “Smart Path” drawing; when the “Smart Paths” checkbox is checked, holding <code class="docutils literal notranslate"><span class="pre">shift</span></code> will temporarily disable it.</p></li>
</ul>
</div>
<div class="section" id="id5">
<h3>Fixed<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<div class="section" id="id8">
<h3>Fixed<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Fix a bug with the current metatile selection zoom.</p></li>
<li><p>Fix bug preventing the status bar from updating the current position while dragging events.</p></li>
@ -425,26 +495,26 @@ and this project somewhat adheres to <a class="reference external" href="https:/
</ul>
</div>
</div>
<div class="section" id="id6">
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.3.0...4.3.1">4.3.1</a> - 2020-07-17<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h2>
<div class="section" id="id7">
<h3>Added<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<div class="section" id="id9">
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.3.0...4.3.1">4.3.1</a> - 2020-07-17<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>
<ul class="simple">
<li><p>Add keyboard shortcut <code class="docutils literal notranslate"><span class="pre">Ctrl</span> <span class="pre">+</span> <span class="pre">D</span></code> for duplicating map events.</p></li>
<li><p>Add keyboard shortcut <code class="docutils literal notranslate"><span class="pre">Ctrl</span> <span class="pre">+</span> <span class="pre">Shift</span> <span class="pre">+</span> <span class="pre">Z</span></code> for “redo” in the tileset editor.</p></li>
<li><p>Add scripting api to reorder metatile layers and draw them with opacity.</p></li>
</ul>
</div>
<div class="section" id="id8">
<h3>Changed<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3>
<div class="section" id="id11">
<h3>Changed<a class="headerlink" href="#id11" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>The tileset editor now syncs its metatile selection with the maps metatile selector.</p></li>
<li><p>The number of object events per map is now limited to OBJECT_EVENT_TEMPLATES_COUNT</p></li>
<li><p>The tileset editor can now flip selections that were taken from an existing metatile.</p></li>
</ul>
</div>
<div class="section" id="id9">
<h3>Fixed<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3>
<div class="section" id="id12">
<h3>Fixed<a class="headerlink" href="#id12" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Fix bug where editing a metatile layer would have no effect.</p></li>
<li><p>Fix a crash that occured when creating a new tileset using triple layer mode.</p></li>
@ -455,22 +525,22 @@ and this project somewhat adheres to <a class="reference external" href="https:/
</ul>
</div>
</div>
<div class="section" id="id10">
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.2.0...4.3.0">4.3.0</a> - 2020-06-27<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h2>
<div class="section" id="id11">
<h3>Added<a class="headerlink" href="#id11" title="Permalink to this headline"></a></h3>
<div class="section" id="id13">
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.2.0...4.3.0">4.3.0</a> - 2020-06-27<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>
<ul class="simple">
<li><p>Add triple-layer metatiles support.</p></li>
</ul>
</div>
<div class="section" id="id12">
<h3>Changed<a class="headerlink" href="#id12" title="Permalink to this headline"></a></h3>
<div class="section" id="id15">
<h3>Changed<a class="headerlink" href="#id15" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>The “Open Scripts” button will fall back to <code class="docutils literal notranslate"><span class="pre">scripts.inc</span></code> if <code class="docutils literal notranslate"><span class="pre">scripts.pory</span></code> doesnt exist.</p></li>
</ul>
</div>
<div class="section" id="id13">
<h3>Fixed<a class="headerlink" href="#id13" title="Permalink to this headline"></a></h3>
<div class="section" id="id16">
<h3>Fixed<a class="headerlink" href="#id16" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Fix bug where exported tileset images could be horizontally or vertically flipped.</p></li>
<li><p>Fix bug where the map list wasnt filtered properly after switching filter types.</p></li>
@ -478,47 +548,47 @@ and this project somewhat adheres to <a class="reference external" href="https:/
</ul>
</div>
</div>
<div class="section" id="id14">
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.1.0...4.2.0">4.2.0</a> - 2020-06-06<a class="headerlink" href="#id14" title="Permalink to this headline"></a></h2>
<div class="section" id="id15">
<h3>Added<a class="headerlink" href="#id15" title="Permalink to this headline"></a></h3>
<div class="section" id="id17">
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.1.0...4.2.0">4.2.0</a> - 2020-06-06<a class="headerlink" href="#id17" title="Permalink to this headline"></a></h2>
<div class="section" id="id18">
<h3>Added<a class="headerlink" href="#id18" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Add more project-specific configs to better support porting features from different projects.</p></li>
<li><p>Add metatile label names to the status bar when hovering over metatiles in the map editor tab.</p></li>
<li><p>Add mouse coordinates to the status bar when hovering in the events tab.</p></li>
</ul>
</div>
<div class="section" id="id16">
<h3>Changed<a class="headerlink" href="#id16" title="Permalink to this headline"></a></h3>
<div class="section" id="id19">
<h3>Changed<a class="headerlink" href="#id19" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">metatile_labels.h</span></code> is now watched for changes.</p></li>
</ul>
</div>
<div class="section" id="id17">
<h3>Fixed<a class="headerlink" href="#id17" title="Permalink to this headline"></a></h3>
<div class="section" id="id20">
<h3>Fixed<a class="headerlink" href="#id20" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Reduce time it takes to load maps and save in the tileset editor.</p></li>
<li><p>Fix crash that could occur when parsing unknown symbols when evaluating <code class="docutils literal notranslate"><span class="pre">define</span></code> expressions.</p></li>
</ul>
</div>
</div>
<div class="section" id="id18">
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.0.0...4.1.0">4.1.0</a> - 2020-05-18<a class="headerlink" href="#id18" title="Permalink to this headline"></a></h2>
<div class="section" id="id19">
<h3>Added<a class="headerlink" href="#id19" title="Permalink to this headline"></a></h3>
<div class="section" id="id21">
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.0.0...4.1.0">4.1.0</a> - 2020-05-18<a class="headerlink" href="#id21" title="Permalink to this headline"></a></h2>
<div class="section" id="id22">
<h3>Added<a class="headerlink" href="#id22" 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="id20">
<h3>Changed<a class="headerlink" href="#id20" title="Permalink to this headline"></a></h3>
<div class="section" id="id23">
<h3>Changed<a class="headerlink" href="#id23" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Edit modes are no longer shared between the Map and Events tabs. Pencil is default for Map tab, and Pointer is default for Events tab.</p></li>
</ul>
</div>
<div class="section" id="id21">
<h3>Fixed<a class="headerlink" href="#id21" title="Permalink to this headline"></a></h3>
<div class="section" id="id24">
<h3>Fixed<a class="headerlink" href="#id24" 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>
@ -529,16 +599,16 @@ and this project somewhat adheres to <a class="reference external" href="https:/
</ul>
</div>
</div>
<div class="section" id="id22">
<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="#id22" 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="id25">
<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="#id25" title="Permalink to this headline"></a></h2>
<div class="section" id="id26">
<h3>Breaking Changes<a class="headerlink" href="#id26" 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="id23">
<h3>Added<a class="headerlink" href="#id23" title="Permalink to this headline"></a></h3>
<div class="section" id="id27">
<h3>Added<a class="headerlink" href="#id27" 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">-&gt;</span> <span class="pre">Export</span> <span class="pre">Map</span> <span class="pre">Stitch</span> <span class="pre">Image...</span></code>.</p></li>
@ -549,8 +619,8 @@ and this project somewhat adheres to <a class="reference external" href="https:/
<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="id24">
<h3>Changed<a class="headerlink" href="#id24" title="Permalink to this headline"></a></h3>
<div class="section" id="id28">
<h3>Changed<a class="headerlink" href="#id28" 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>
@ -558,8 +628,8 @@ and this project somewhat adheres to <a class="reference external" href="https:/
<li><p>Extend connection min and max offsets to players view boundary, rather than the maps boundary.</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="id29">
<h3>Fixed<a class="headerlink" href="#id29" 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>
@ -568,19 +638,19 @@ 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/compare/3.0.0...3.0.1">3.0.1</a> - 2020-03-04<a class="headerlink" href="#id26" title="Permalink to this headline"></a></h2>
<div class="section" id="id27">
<h3>Fixed<a class="headerlink" href="#id27" title="Permalink to this headline"></a></h3>
<div class="section" id="id30">
<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="#id30" title="Permalink to this headline"></a></h2>
<div class="section" id="id31">
<h3>Fixed<a class="headerlink" href="#id31" 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="id28">
<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="#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>
<div class="section" id="id32">
<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="#id32" title="Permalink to this headline"></a></h2>
<div class="section" id="id33">
<h3>Breaking Changes<a class="headerlink" href="#id33" 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>
@ -590,22 +660,22 @@ and this project somewhat adheres to <a class="reference external" href="https:/
</li>
</ul>
</div>
<div class="section" id="id30">
<h3>Added<a class="headerlink" href="#id30" title="Permalink to this headline"></a></h3>
<div class="section" id="id34">
<h3>Added<a class="headerlink" href="#id34" 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="id31">
<h3>Changed<a class="headerlink" href="#id31" title="Permalink to this headline"></a></h3>
<div class="section" id="id35">
<h3>Changed<a class="headerlink" href="#id35" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Draw map connections with the current maps tilesets to more accurately mimic their appearance in-game.</p></li>
</ul>
</div>
<div class="section" id="id32">
<h3>Fixed<a class="headerlink" href="#id32" title="Permalink to this headline"></a></h3>
<div class="section" id="id36">
<h3>Fixed<a class="headerlink" href="#id36" 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>
@ -615,17 +685,17 @@ and this project somewhat adheres to <a class="reference external" href="https:/
</ul>
</div>
</div>
<div class="section" id="id33">
<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="#id33" title="Permalink to this headline"></a></h2>
<div class="section" id="id34">
<h3>Breaking Changes<a class="headerlink" href="#id34" title="Permalink to this headline"></a></h3>
<div class="section" id="id37">
<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="#id37" title="Permalink to this headline"></a></h2>
<div class="section" id="id38">
<h3>Breaking Changes<a class="headerlink" href="#id38" 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="id35">
<h3>Added<a class="headerlink" href="#id35" title="Permalink to this headline"></a></h3>
<div class="section" id="id39">
<h3>Added<a class="headerlink" href="#id39" 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>
@ -633,16 +703,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="id36">
<h3>Changed<a class="headerlink" href="#id36" title="Permalink to this headline"></a></h3>
<div class="section" id="id40">
<h3>Changed<a class="headerlink" href="#id40" 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 porymaps comboboxes no longer require typing the full string prefix.</p></li>
</ul>
</div>
<div class="section" id="id37">
<h3>Fixed<a class="headerlink" href="#id37" title="Permalink to this headline"></a></h3>
<div class="section" id="id41">
<h3>Fixed<a class="headerlink" href="#id41" 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 werent properly painted when clicking on the bottom row of the metatile layers.</p></li>
@ -653,18 +723,18 @@ and this project somewhat adheres to <a class="reference external" href="https:/
</ul>
</div>
</div>
<div class="section" id="id38">
<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="#id38" title="Permalink to this headline"></a></h2>
<div class="section" id="id39">
<h3>Added<a class="headerlink" href="#id39" title="Permalink to this headline"></a></h3>
<div class="section" id="id42">
<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="#id42" title="Permalink to this headline"></a></h2>
<div class="section" id="id43">
<h3>Added<a class="headerlink" href="#id43" 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="id40">
<h3>Changed<a class="headerlink" href="#id40" title="Permalink to this headline"></a></h3>
<div class="section" id="id44">
<h3>Changed<a class="headerlink" href="#id44" 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>
@ -674,8 +744,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="id41">
<h3>Fixed<a class="headerlink" href="#id41" title="Permalink to this headline"></a></h3>
<div class="section" id="id45">
<h3>Fixed<a class="headerlink" href="#id45" 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>
@ -684,32 +754,32 @@ and this project somewhat adheres to <a class="reference external" href="https:/
</ul>
</div>
</div>
<div class="section" id="id42">
<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="#id42" title="Permalink to this headline"></a></h2>
<div class="section" id="id43">
<h3>Added<a class="headerlink" href="#id43" title="Permalink to this headline"></a></h3>
<div class="section" id="id46">
<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="#id46" title="Permalink to this headline"></a></h2>
<div class="section" id="id47">
<h3>Added<a class="headerlink" href="#id47" 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="id44">
<h3>Fixed<a class="headerlink" href="#id44" title="Permalink to this headline"></a></h3>
<div class="section" id="id48">
<h3>Fixed<a class="headerlink" href="#id48" 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="id45">
<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="#id45" title="Permalink to this headline"></a></h2>
<div class="section" id="id46">
<h3>Breaking Changes<a class="headerlink" href="#id46" title="Permalink to this headline"></a></h3>
<div class="section" id="id49">
<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="#id49" title="Permalink to this headline"></a></h2>
<div class="section" id="id50">
<h3>Breaking Changes<a class="headerlink" href="#id50" 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="id47">
<h3>Added<a class="headerlink" href="#id47" title="Permalink to this headline"></a></h3>
<div class="section" id="id51">
<h3>Added<a class="headerlink" href="#id51" 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>
@ -722,8 +792,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="id48">
<h3>Changed<a class="headerlink" href="#id48" title="Permalink to this headline"></a></h3>
<div class="section" id="id52">
<h3>Changed<a class="headerlink" href="#id52" 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>
@ -737,8 +807,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="id49">
<h3>Fixed<a class="headerlink" href="#id49" title="Permalink to this headline"></a></h3>
<div class="section" id="id53">
<h3>Fixed<a class="headerlink" href="#id53" 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>
@ -747,32 +817,32 @@ and this project somewhat adheres to <a class="reference external" href="https:/
</ul>
</div>
</div>
<div class="section" id="id50">
<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="#id50" title="Permalink to this headline"></a></h2>
<div class="section" id="id51">
<h3>Breaking Changes<a class="headerlink" href="#id51" title="Permalink to this headline"></a></h3>
<div class="section" id="id54">
<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="#id54" title="Permalink to this headline"></a></h2>
<div class="section" id="id55">
<h3>Breaking Changes<a class="headerlink" href="#id55" 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="id52">
<h3>Added<a class="headerlink" href="#id52" title="Permalink to this headline"></a></h3>
<div class="section" id="id56">
<h3>Added<a class="headerlink" href="#id56" 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="id53">
<h3>Changed<a class="headerlink" href="#id53" title="Permalink to this headline"></a></h3>
<div class="section" id="id57">
<h3>Changed<a class="headerlink" href="#id57" 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="id54">
<h3>Fixed<a class="headerlink" href="#id54" title="Permalink to this headline"></a></h3>
<div class="section" id="id58">
<h3>Fixed<a class="headerlink" href="#id58" 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>
@ -785,8 +855,8 @@ and this project somewhat adheres to <a class="reference external" href="https:/
</ul>
</div>
</div>
<div class="section" id="id55">
<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="#id55" title="Permalink to this headline"></a></h2>
<div class="section" id="id59">
<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="#id59" title="Permalink to this headline"></a></h2>
<p>This was the initial release.</p>
</div>
</div>

View file

@ -108,6 +108,7 @@
<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 &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-collisions.html">Editing Map Collisions</a><ul>
@ -120,6 +121,7 @@
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#object-events">Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#clone-object-events">Clone Object Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
@ -152,7 +154,25 @@
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-entries-tab">Map Entries Tab</a></li>
<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/tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#palette-editor">Palette Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
@ -162,6 +182,7 @@
<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-header-editing-functions">Map Header 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>
@ -184,94 +205,100 @@
<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">4.5.0 - 2021-12-26</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#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#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id4">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id4">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id6">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id9">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id5">4.4.0 - 2020-12-20</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id10">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id11">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id13">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id9">4.3.1 - 2020-07-17</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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id14">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id16">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id16">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id18">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id20">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id21">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id17">4.2.0 - 2020-06-06</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id22">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#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#id21">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id23">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id26">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id27">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id25">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id26">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id27">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id28">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id29">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id28">3.0.0 - 2020-03-04</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>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id30">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id31">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id33">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id34">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id35">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id36">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id37">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id32">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id33">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id34">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id35">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id36">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id38">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id37">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id38">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id41">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id42">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id42">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id43">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id44">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id44">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id45">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id45">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id46">Breaking Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id46">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id47">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id48">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id49">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id50">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id51">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id52">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id53">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id54">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id49">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id55">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id54">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id55">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id56">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id57">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id58">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id59">1.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>

File diff suppressed because one or more lines are too long

View file

@ -167,3 +167,31 @@ Undo & Redo
-----------
When painting metatiles, you can undo and redo actions you take. This makes it very easy to fix mistakes or go back in time. Undo can be performed with ``Ctrl+Z`` or *Edit -> Undo*. Redo can be performed with ``Ctrl+Y`` or *Edit -> Redo*.
Prefabs
-------
Prefabs, or "prefabricated selections", are a way to optimize your map-editing workflow by defining pre-built metatile selections. This can be useful when larger map objects can't be selected from the main metatile selector window. For example, the Poké Mart building is only partially selectable in the metatile selector view.
.. figure:: images/editing-map-tiles/prefab-list.png
:alt: Prefab Tab
Prefab Tab
To create a new prefab, simply select a group of metatiles from the main map view. (See the `Selecting Metatiles`_. section above for how to use right-click-drag to select from the map area.) Then, click the "Create from Selection" button. This will bring up the following window where individual metatiles can be toggled on/off in the prefab. You can also give your prefab a name.
.. figure:: images/editing-map-tiles/prefab-create.png
:alt: Prefab Creation Window
Prefab Creation Window
Prefabs are designated for whichever primary and secondary tilesets were used to create them. As such, any prefabs for with tilesets that are incompatible with the currently-opened map will be hidden from the Prefab list.
To select a prefab to use for painting on the map, simply click on the prefab image in the list view.
.. figure:: images/editing-map-tiles/prefab-demo.gif
:alt: Painting with a Prefab
Painting with a Prefab
Prefab data is saved to a JSON file. It defaults to ``<project_root>/prefabs.json``. However, it can be configured in Porymap's project config file.

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 352 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

View file

@ -48,5 +48,6 @@ determined by this file.
``create_map_text_file``, 1 if not ``pokeemerald``, project, yes, A ``text.inc`` or ``text.pory`` file will be created for any new map
``enable_triple_layer_metatiles``, 0, project, yes, Enables triple-layer metatiles (See https://github.com/pret/pokeemerald/wiki/Triple-layer-metatiles)
``custom_scripts``, , project, yes, A list of script files to load into the scripting engine
``prefabs_filepath``, ``<project_root>/prefabs.json``, project, yes, The filepath containing prefab JSON data
Some of these settings can be toggled manually in porymap via the *Options* menu.

View file

@ -26,12 +26,27 @@
<string>Frame</string>
</property>
<property name="frameShape">
<enum>QFrame::Box</enum>
<enum>QFrame::NoFrame</enum>
</property>
<property name="frameShadow">
<enum>QFrame::Plain</enum>
</property>
<layout class="QHBoxLayout" name="horizontalLayout">
<property name="sizeConstraint">
<enum>QLayout::SetMinimumSize</enum>
</property>
<property name="leftMargin">
<number>0</number>
</property>
<property name="topMargin">
<number>2</number>
</property>
<property name="rightMargin">
<number>0</number>
</property>
<property name="bottomMargin">
<number>2</number>
</property>
<item>
<layout class="QVBoxLayout" name="verticalLayout">
<property name="spacing">
@ -62,13 +77,13 @@
<number>0</number>
</property>
<property name="topMargin">
<number>6</number>
<number>0</number>
</property>
<property name="rightMargin">
<number>9</number>
<number>0</number>
</property>
<property name="bottomMargin">
<number>6</number>
<number>0</number>
</property>
<item>
<widget class="QPushButton" name="pushButton_DeleteItem">