From 16926144da4334c843f6478e338d977daecaaa1b Mon Sep 17 00:00:00 2001 From: Marcus Huderle Date: Sat, 29 Oct 2022 11:29:38 -0500 Subject: [PATCH 1/3] Fix event offsets in map image exporting --- src/ui/mapimageexporter.cpp | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/ui/mapimageexporter.cpp b/src/ui/mapimageexporter.cpp index 5c5e4b78..a54b72a3 100644 --- a/src/ui/mapimageexporter.cpp +++ b/src/ui/mapimageexporter.cpp @@ -407,6 +407,10 @@ QPixmap MapImageExporter::getFormattedMapPixmap(Map *map, bool ignoreBorder) { // draw events QPainter eventPainter(&pixmap); QList events = map->getAllEvents(); + int pixelOffset = 0; + if (!ignoreBorder && showBorder) { + pixelOffset = this->mode == ImageExporterMode::Normal ? BORDER_DISTANCE * 16 : STITCH_MODE_BORDER_DISTANCE * 16; + } for (Event *event : events) { editor->project->setEventPixmap(event); Event::Group group = event->getEventGroup(); @@ -415,7 +419,7 @@ QPixmap MapImageExporter::getFormattedMapPixmap(Map *map, bool ignoreBorder) { || (showBGs && group == Event::Group::Bg) || (showTriggers && group == Event::Group::Coord) || (showHealSpots && group == Event::Group::Heal)) - eventPainter.drawImage(QPoint(event->getPixelX(), event->getPixelY()), event->getPixmap().toImage()); + eventPainter.drawImage(QPoint(event->getPixelX() + pixelOffset, event->getPixelY() + pixelOffset), event->getPixmap().toImage()); } eventPainter.end(); From 01cbb523416abf475eb4d7784c8667355c35a719 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Sat, 29 Oct 2022 17:16:52 -0400 Subject: [PATCH 2/3] Preserve null custom attributes --- src/lib/orderedjson.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/orderedjson.cpp b/src/lib/orderedjson.cpp index 025607ca..07c31225 100644 --- a/src/lib/orderedjson.cpp +++ b/src/lib/orderedjson.cpp @@ -311,7 +311,6 @@ const Json & JsonArray::operator[] (int i) const { const Json Json::fromQJsonValue(QJsonValue value) { switch (value.type()) { - default: case QJsonValue::String: return value.toString(); case QJsonValue::Double: return value.toInt(); case QJsonValue::Bool: return value.toBool(); @@ -331,6 +330,7 @@ const Json Json::fromQJsonValue(QJsonValue value) { obj[it.key()] = Json::fromQJsonValue(it.value()); return obj; } + default: return static_null(); } } From 5362c996e5e790a9d0918c63c4ee3811d1d9b79f Mon Sep 17 00:00:00 2001 From: Marcus Huderle Date: Sun, 30 Oct 2022 10:05:55 -0500 Subject: [PATCH 3/3] Release 5.0.0 --- CHANGELOG.md | 6 +- .../_sources/manual/editing-map-tiles.rst.txt | 4 +- docs/_sources/manual/project-files.rst.txt | 85 +- .../manual/scripting-capabilities.rst.txt | 1076 +++++---- .../manual/settings-and-options.rst.txt | 20 +- docs/_sources/reference/CHANGELOG.md.txt | 50 +- docs/genindex.html | 428 ++-- docs/index.html | 155 +- docs/manual/editing-map-tiles.html | 127 +- docs/manual/project-files.html | 246 +- docs/manual/scripting-capabilities.html | 2152 ++++++++++------- docs/manual/settings-and-options.html | 220 +- docs/objects.inv | Bin 1742 -> 1911 bytes docs/reference/changelog.html | 382 +-- docs/search.html | 124 +- docs/searchindex.js | 2 +- forms/aboutporymap.ui | 73 +- 17 files changed, 3033 insertions(+), 2117 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a0a7e638..9f4417ab 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,9 @@ 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. It also includes changes to the scripting API that may change the behavior of existing porymap scripts. If porymap is used with a project or API script that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly. ## [Unreleased] +Nothing, yet. + +## [5.0.0] - 2022-10-30 ### 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). - Warp IDs are now treated as strings, which requires the change to `mapjson` made in [pokeemerald/#1755](https://github.com/pret/pokeemerald/pull/1755). Additionally `MAP_NONE` was renamed to `MAP_DYNAMIC`. Both changes also apply to pokefirered and pokeruby. @@ -346,7 +349,8 @@ The **"Breaking Changes"** listed below are changes that have been made in the d ## [1.0.0] - 2018-10-26 This was the initial release. -[Unreleased]: https://github.com/huderlem/porymap/compare/4.5.0...HEAD +[Unreleased]: https://github.com/huderlem/porymap/compare/5.0.0...HEAD +[5.0.0]: https://github.com/huderlem/porymap/compare/4.5.0...5.0.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 diff --git a/docs/_sources/manual/editing-map-tiles.rst.txt b/docs/_sources/manual/editing-map-tiles.rst.txt index ef0aa278..4d51b3fb 100644 --- a/docs/_sources/manual/editing-map-tiles.rst.txt +++ b/docs/_sources/manual/editing-map-tiles.rst.txt @@ -178,6 +178,8 @@ Prefabs, or "prefabricated selections", are a way to optimize your map-editing w Prefab Tab +Porymap provides a set of default prefabs for each supported base game version (pokeemerald, pokefirered, and pokeruby). When opening a project for the first time, Porymap will prompt the user for importing those default prefabs. + 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 @@ -194,4 +196,4 @@ To select a prefab to use for painting on the map, simply click on the prefab im Painting with a Prefab -Prefab data is saved to a JSON file. It defaults to ``/prefabs.json``. However, it can be configured in Porymap's project config file. +Prefab data is saved to a JSON file. It defaults to ``/prefabs.json``. However, it can be configured in Porymap's project config file using the ``prefabs_filepath`` setting. diff --git a/docs/_sources/manual/project-files.rst.txt b/docs/_sources/manual/project-files.rst.txt index 46554bb5..78a899dc 100644 --- a/docs/_sources/manual/project-files.rst.txt +++ b/docs/_sources/manual/project-files.rst.txt @@ -6,43 +6,58 @@ Porymap relies on the user maintaining a certain level of integrity with their p This is a list of files that porymap reads from and writes to. Generally, if porymap writes to a file, it probably is not a good idea to edit yourself unless otherwise noted. +The filepath that Porymap expects for each file can be overridden with config options. The name of each config override is listed in the table, and should begin with ``path/``. +For example if you wanted to rename ``include/constants/items.h`` to ``headers/defines/stuff.h``, you would add ``path/constants_items=headers/defines/stuff.h`` to your project's ``porymap.project.cfg`` file. + .. csv-table:: - :header: File Name,Read,Write,Notes - :widths: 20, 5, 5, 30 + :header: File Name,Read,Write,Override,Notes + :widths: 20, 5, 5, 20, 30 - data/maps/\*/map.json, yes, yes, - data/event_scripts.s, no, yes, only appends new script files to end of file - data/maps/map_groups.json, yes, yes, - data/layouts/layouts.json, yes, yes, also reads border and blockdata files listed in this file - data/tilesets/headers.inc, yes, yes, - data/tilesets/graphics.inc, yes, yes, also edits palette and tile image files listed in this file - data/tilesets/metatiles.inc, yes, yes, also edits metatile files listed in this file - src/data/wild_encounters.json, yes, yes, - src/data/object_events/object_event_graphics_info_pointers.h, yes, no, - src/data/object_events/object_event_graphics_info.h, yes, no, - src/data/object_events/object_event_pic_tables.h, yes, no, - src/data/object_events/object_event_graphics.h, yes, no, - src/data/graphics/pokemon.h, yes, no, for pokemon sprite icons - src/data/heal_locations.h, yes, yes, - src/data/region_map/region_map_entries.h, yes, yes, - include/constants/global.h, yes, no, - include/constants/map_groups.h, no, yes, - include/constants/items.h, yes, no, - include/constants/opponents.h, yes, no, reads max trainers constant - include/constants/flags.h, yes, no, - include/constants/vars.h, yes, no, - include/constants/weather.h, yes, no, - include/constants/heal_locations.h, no, yes, - include/constants/pokemon.h, yes, no, reads min and max level constants - include/constants/map_types.h, yes, no, - include/constants/trainer_types.h, yes, no, - include/constants/secret_bases.h, yes, no, pokeemerald and pokeruby only - include/constants/event_object_movement.h, yes, no, - include/constants/event_bg.h, yes, no, - include/constants/region_map_sections.h, yes, no, - include/constants/metatile_labels.h, yes, yes, - include/constants/metatile_behaviors.h, yes, no, - include/fieldmap.h, yes, no, reads tileset related constants + data/maps/\*/map.json, yes, yes, ``data_map_folders``, + data/maps/\*/scripts.[inc|pory], yes, no, ``data_map_folders``, for finding script labels + data/scripts/\*.[inc|pory], yes, no, ``data_scripts_folders``, for finding script labels + data/event_scripts.s, no, yes, ``data_event_scripts``, only appends new script files to end of file + data/maps/map_groups.json, yes, yes, ``json_map_groups``, + data/layouts/layouts.json, yes, yes, ``json_layouts``, + data/layouts/\*/[border|map].bin, yes, yes, ``data_layouts_folders``, + src/data/tilesets/headers.h, yes, yes, ``tilesets_headers``, + src/data/tilesets/graphics.h, yes, yes, ``tilesets_graphics``, also edits palette and tile image files listed in this file + src/data/tilesets/metatiles.h, yes, yes, ``tilesets_metatiles``, also edits metatile files listed in this file + data/tilesets/headers.inc, yes, yes, ``tilesets_headers_asm``, only if ``tilesets_headers`` can't be found + data/tilesets/graphics.inc, yes, yes, ``tilesets_graphics_asm``, only if ``tilesets_headers`` can't be found + data/tilesets/metatiles.inc, yes, yes, ``tilesets_metatiles_asm``, only if ``tilesets_headers`` can't be found + data/tilesets/[primary|secondary]/\*, yes, yes, ``data_tilesets_folders``, default tileset data location + src/data/wild_encounters.json, yes, yes, ``json_wild_encounters``, + src/data/object_events/object_event_graphics_info_pointers.h, yes, no, ``data_obj_event_gfx_pointers``, + src/data/object_events/object_event_graphics_info.h, yes, no, ``data_obj_event_gfx_info``, + src/data/object_events/object_event_pic_tables.h, yes, no, ``data_obj_event_pic_tables``, + src/data/object_events/object_event_graphics.h, yes, no, ``data_obj_event_gfx``, + src/data/graphics/pokemon.h, yes, no, ``data_pokemon_gfx``, for pokemon sprite icons + src/data/heal_locations.h, yes, yes, ``data_heal_locations``, + src/data/region_map/region_map_sections.json, yes, yes, ``json_region_map_entries``, + src/data/region_map/porymap_config.json, yes, yes, ``json_region_porymap_cfg``, + include/constants/global.h, yes, no, ``constants_global``, reads ``OBJECT_EVENT_TEMPLATES_COUNT`` + include/constants/map_groups.h, no, yes, ``constants_map_groups``, + include/constants/items.h, yes, no, ``constants_items``, + include/constants/opponents.h, yes, no, ``constants_opponents``, reads max trainers constant + include/constants/flags.h, yes, no, ``constants_flags``, + include/constants/vars.h, yes, no, ``constants_vars``, + include/constants/weather.h, yes, no, ``constants_weather``, + include/constants/songs.h, yes, no, ``constants_songs``, + include/constants/heal_locations.h, yes, yes, ``constants_heal_locations``, + include/constants/pokemon.h, yes, no, ``constants_pokemon``, reads min and max level constants + include/constants/map_types.h, yes, no, ``constants_map_types``, + include/constants/trainer_types.h, yes, no, ``constants_trainer_types``, + include/constants/secret_bases.h, yes, no, ``constants_secret_bases``, pokeemerald and pokeruby only + include/constants/event_object_movement.h, yes, no, ``constants_obj_event_movement``, + include/constants/event_objects.h, yes, no, ``constants_obj_events``, + include/constants/event_bg.h, yes, no, ``constants_event_bg``, + include/constants/region_map_sections.h, yes, no, ``constants_region_map_sections``, + include/constants/metatile_labels.h, yes, yes, ``constants_metatile_labels``, + include/constants/metatile_behaviors.h, yes, no, ``constants_metatile_behaviors``, + include/fieldmap.h, yes, no, ``constants_fieldmap``, reads tileset related constants + src/event_object_movement.c, yes, no, ``initial_facing_table``, reads ``gInitialMovementTypeFacingDirections`` + src/pokemon_icon.c, yes, no, ``pokemon_icon_table``, reads files in ``gMonIconTable`` diff --git a/docs/_sources/manual/scripting-capabilities.rst.txt b/docs/_sources/manual/scripting-capabilities.rst.txt index 133cdaeb..013460fa 100644 --- a/docs/_sources/manual/scripting-capabilities.rst.txt +++ b/docs/_sources/manual/scripting-capabilities.rst.txt @@ -78,7 +78,7 @@ The grass-randomizer script above happens implicitly when the user paints on the // Porymap callback when project is opened. export function onProjectOpened(projectPath) { - map.registerAction("applyNightTint", "View Night Tint", "T") + utility.registerAction("applyNightTint", "View Night Tint", "T") } Then, to trigger the ``applyNightTint()`` function, we could either click ``Tools -> View Night Tint`` or use the ``T`` keyboard shortcut. @@ -178,7 +178,7 @@ Callbacks .. js:function:: onMapViewTabChanged(oldTab, newTab) - Called when the selected tab in the map view tab bar is changed. Tabs are indexed from left to right, starting at 0 (``0``: Metatiles, ``1``: Collision). + Called when the selected tab in the map view tab bar is changed. Tabs are indexed from left to right, starting at 0 (``0``: Metatiles, ``1``: Collision, ``2``: Prefabs). :param number oldTab: the index of the previously selected tab :param number newTab: the index of the newly selected tab @@ -192,13 +192,13 @@ Callbacks Functions ~~~~~~~~~ -All scripting functions are callable via the global ``map`` object. - Map Editing Functions ^^^^^^^^^^^^^^^^^^^^^ The following functions are related to editing the map's blocks or retrieving information about them. +All map editing functions are callable via the global ``map`` object. + .. js:function:: map.getBlock(x, y) Gets a block in the currently-opened map. @@ -444,6 +444,8 @@ Map Header Editing Functions The following functions are related to reading/writing the map's header properties. +All map header functions are callable via the global ``map`` object. + .. js:function:: map.getSong() Gets the name of the background song for the currently-opened map. @@ -576,374 +578,12 @@ The following functions are related to reading/writing the map's header properti :param number floorNumber: the floor number -Map Overlay Functions -^^^^^^^^^^^^^^^^^^^^^ - -The following functions are related to an overlay that is drawn on top of the map area. Text, images, and shapes can be drawn using these functions. Items can be drawn and manipulated on separate layers by specifiying a layer id. Items on higher layer ids will be drawn above those on lower layers. If no layer is specified they will be added to the default layer ``0``. The visibility and position of each layer can be changed; by default all layers are visible, and their position is ``0,0``. - -.. js:function:: map.clearOverlay(layer = 0) - - Clears and erases all overlay items on the specified layer that were previously-added to the map. - - :param number layer: the layer id. Defaults to ``0`` - -.. js:function:: map.clearOverlays() - - Clears and erases all overlay items that were previously-added to the map. - -.. js:function:: map.hideOverlay(layer = 0) - - Hides all overlay items on the specified layer. - - :param number layer: the layer id. Defaults to ``0`` - -.. js:function:: map.hideOverlays() - - Hides all overlay items on all active layers. - -.. js:function:: map.showOverlay(layer = 0) - - Shows all overlay items on the specified layer. - - :param number layer: the layer id. Defaults to ``0`` - -.. js:function:: map.showOverlays() - - Shows all overlay items on all active layers. - -.. js:function:: map.getOverlayVisibility(layer = 0) - - Gets whether the specified overlay layer is currently showing or not. - - :param number layer: the layer id. Defaults to ``0`` - :returns boolean: whether the layer is showing - -.. js:function:: map.setOverlayVisibility(visible, layer = 0) - - Sets the visibility of the specified overlay layer. - - :param boolean visible: whether the layer should be showing - :param number layer: the layer id. Defaults to ``0`` - -.. js:function:: map.setOverlaysVisibility(visible) - - Sets the visibility of all active overlay layers. - - :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. - - :param number layer: the layer id. Defaults to ``0`` - :returns number: the pixel x coordinate - -.. js:function:: map.getOverlayY(layer = 0) - - Gets the y position of the specified overlay layer. - - :param number layer: the layer id. Defaults to ``0`` - :returns number: the pixel y coordinate - -.. js:function:: map.setOverlayX(x, layer = 0) - - Sets the x position of the specified overlay layer. - - :param number x: the pixel x coordinate - :param number layer: the layer id. Defaults to ``0`` - -.. js:function:: map.setOverlayY(y, layer = 0) - - Sets the y position of the specified overlay layer. - - :param number y: the pixel y coordinate - :param number layer: the layer id. Defaults to ``0`` - -.. js:function:: map.setOverlaysX(x) - - Sets the x position of all active overlay layers. - - :param number x: the pixel x coordinate - -.. js:function:: map.setOverlaysY(y) - - Sets the y position of all active overlay layers. - - :param number y: the pixel y coordinate - -.. js:function:: map.getOverlayPosition(layer = 0) - - Gets the position of the specified overlay layer. - - :param number layer: the layer id. Defaults to ``0`` - :returns {x, y}: the layer's pixel coordinates - -.. js:function:: map.setOverlayPosition(x, y, layer = 0) - - Sets the position of the specified overlay layer. - - :param number x: the pixel x coordinate - :param number y: the pixel y coordinate - :param number layer: the layer id. Defaults to ``0`` - -.. js:function:: map.setOverlaysPosition(x, y) - - Sets the position of all active overlay layers. - - :param number x: the pixel x coordinate - :param number y: the pixel y coordinate - -.. js:function:: map.moveOverlay(deltaX, deltaY, layer = 0) - - Moves the specified overlay layer. - - :param number deltaX: the number of pixels to move horizontally - :param number deltaY: the number of pixels to move vertically - :param number layer: the layer id. Defaults to ``0`` - -.. js:function:: map.moveOverlays(deltaX, deltaY) - - Moves all active overlay layers. - - :param number deltaX: the number of pixels to move horizontally - :param number deltaY: the number of pixels to move vertically - -.. js:function:: map.addText(text, x, y, color = "#000000", size = 12, layer = 0) - - Adds a text item to the specified overlay layer. - - :param string text: the text to display - :param number x: the x pixel coordinate of the text (relative to the layer's position) - :param number y: the y pixel coordinate of the text (relative to the layer's position) - :param string color: the color of the text. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black. - :param number size: the font size of the text. Defaults to 12. - :param number layer: the layer id. Defaults to ``0`` - -.. js:function:: map.addRect(x, y, width, height, color = "#000000", layer = 0) - - Adds a rectangle outline item to the specified overlay layer. - - :param number x: the x pixel coordinate of the rectangle's top-left corner (relative to the layer's position) - :param number y: the y pixel coordinate of the rectangle's top-left corner (relative to the layer's position) - :param number width: the pixel width of the rectangle - :param number height: the pixel height of the rectangle - :param string color: the color of the rectangle. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black. - :param number layer: the layer id. Defaults to ``0`` - -.. js:function:: map.addFilledRect(x, y, width, height, color = "#000000", layer = 0) - - Adds a filled rectangle item to the specified overlay layer. - - :param number x: the x pixel coordinate of the rectangle's top-left corner (relative to the layer's position) - :param number y: the y pixel coordinate of the rectangle's top-left corner (relative to the layer's position) - :param number width: the pixel width of the rectangle - :param number height: the pixel height of the rectangle - :param string color: the color of the rectangle. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black. - :param number layer: the layer id. Defaults to ``0`` - -.. js:function:: map.addImage(x, y, filepath, layer = 0, useCache = true) - - Adds an image item to the specified overlay layer. - - :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 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, 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 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 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`` - :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.addTileImage(x, y, tileId, xflip, yflip, palette, setTransparency = false, layer = 0) - - Creates an image of a tile on the specified overlay layer. - - :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 number tileId: tile value for the image - :param boolean xflip: whether the tile image is flipped horizontally - :param boolean yflip: whether the tile image is flipped vertically - :param number palette: palette number for the tile image - :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`` - -.. js:function:: map.addTileImage(x, y, tile, setTransparency = false, layer = 0) - - Creates an image of a tile on the specified overlay layer. This is an overloaded function that takes a single tile as a JavaScript object instead of each of the tile's properties individually. - - :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 {tileId,xflip,yflip,palette} tile: the tile to create an image of - :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`` - -.. js:function:: map.addMetatileImage(x, y, metatileId, setTransparency = false, layer = 0) - - Creates an image of a metatile on the specified overlay layer. - - :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 number metatileId: id of the metatile to create an image of - :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`` - - Tileset Functions ^^^^^^^^^^^^^^^^^ The following functions are related to tilesets and how they are rendered. The functions with "preview" in their name operate on a "fake" version of the palette colors. This means that changing these "preview" colors won't affect the actual tileset colors in the project. A good use of the "preview" palettes would be Day/Night tints, for example. -.. js:function:: map.getPrimaryTilesetPalettePreview(paletteIndex) - - Gets a palette from the primary tileset of the currently-opened map. - - :param number paletteIndex: the palette index - :returns array: array of colors. Each color is a 3-element RGB array - -.. js:function:: map.setPrimaryTilesetPalettePreview(paletteIndex, colors) - - Sets a palette in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap. - - :param number paletteIndex: the palette index - :param array colors: array of colors. Each color is a 3-element RGB array - -.. js:function:: map.getPrimaryTilesetPalettesPreview() - - Gets all of the palettes from the primary tileset of the currently-opened map. - - :returns array: array of arrays of colors. Each color is a 3-element RGB array - -.. js:function:: map.setPrimaryTilesetPalettesPreview(palettes) - - Sets all of the palettes in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap. - - :param array palettes: array of arrays of colors. Each color is a 3-element RGB array - -.. js:function:: map.getSecondaryTilesetPalettePreview(paletteIndex) - - Gets a palette from the secondary tileset of the currently-opened map. - - :param number paletteIndex: the palette index - :returns array: array of colors. Each color is a 3-element RGB array - -.. js:function:: map.setSecondaryTilesetPalettePreview(paletteIndex, colors) - - Sets a palette in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap. - - :param number paletteIndex: the palette index - :param array colors: array of colors. Each color is a 3-element RGB array - -.. js:function:: map.getSecondaryTilesetPalettesPreview() - - Gets all of the palettes from the secondary tileset of the currently-opened map. - - :returns array: array of arrays of colors. Each color is a 3-element RGB array - -.. js:function:: map.setSecondaryTilesetPalettesPreview(palettes) - - Sets all of the palettes in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap. - - :param array palettes: array of arrays of colors. Each color is a 3-element RGB array - -.. js:function:: map.getPrimaryTilesetPalette(paletteIndex) - - Gets a palette from the primary tileset of the currently-opened map. - - :param number paletteIndex: the palette index - :returns array: array of colors. Each color is a 3-element RGB array - -.. js:function:: map.setPrimaryTilesetPalette(paletteIndex, colors) - - Sets a palette in the primary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk. - - :param number paletteIndex: the palette index - :param array colors: array of colors. Each color is a 3-element RGB array - -.. js:function:: map.getPrimaryTilesetPalettes() - - Gets all of the palettes from the primary tileset of the currently-opened map. - - :returns array: array of arrays of colors. Each color is a 3-element RGB array - -.. js:function:: map.setPrimaryTilesetPalettes(palettes) - - Sets all of the palettes in the primary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk. - - :param array palettes: array of arrays of colors. Each color is a 3-element RGB array - -.. js:function:: map.getSecondaryTilesetPalette(paletteIndex) - - Gets a palette from the secondary tileset of the currently-opened map. - - :param number paletteIndex: the palette index - :returns array: array of colors. Each color is a 3-element RGB array - -.. js:function:: map.setSecondaryTilesetPalette(paletteIndex, colors) - - Sets a palette in the secondary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk. - - :param number paletteIndex: the palette index - :param array colors: array of colors. Each color is a 3-element RGB array - -.. js:function:: map.getSecondaryTilesetPalettes() - - Gets all of the palettes from the secondary tileset of the currently-opened map. - - :returns array: array of arrays of colors. Each color is a 3-element RGB array - -.. js:function:: map.setSecondaryTilesetPalettes(palettes) - - Sets all of the palettes in the secondary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk. - - :param array palettes: array of arrays of colors. Each color is a 3-element RGB array - -.. js:function:: map.isPrimaryTileset(tilesetName) - - Gets whether the specified tileset is a primary tileset. - - :param string tilesetName: the tileset name - :returns boolean: is a primary tileset - -.. js:function:: map.isSecondaryTileset(tilesetName) - - Gets whether the specified tileset is a secondary tileset. - - :param string tilesetName: the tileset name - :returns boolean: is a secondary tileset +All tileset functions are callable via the global ``map`` object. .. js:function:: map.getPrimaryTileset() @@ -969,65 +609,141 @@ The following functions are related to tilesets and how they are rendered. The f :param string tileset: the tileset name -.. js:function:: map.getNumPrimaryTilesetMetatiles() - - Gets the number of metatiles in the primary tileset for the currently-opened map. - - :returns number: number of metatiles - -.. js:function:: map.getMaxPrimaryTilesetMetatiles() - - Gets the maximum number of metatiles allowed in a primary tileset. - - :returns number: maximum number of metatiles - -.. js:function:: map.getNumSecondaryTilesetMetatiles() - - Gets the number of metatiles in the secondary tileset for the currently-opened map. - - :returns number: number of metatiles - -.. js:function:: map.getMaxSecondaryTilesetMetatiles() - - Gets the maximum number of metatiles allowed in a secondary tileset. - - :returns number: maximum number of metatiles - .. js:function:: map.getNumPrimaryTilesetTiles() Gets the number of tiles in the primary tileset for the currently-opened map. :returns number: number of tiles -.. js:function:: map.getMaxPrimaryTilesetTiles() - - Gets the maximum number of tiles allowed in a primary tileset. - - :returns number: maximum number of tiles - .. js:function:: map.getNumSecondaryTilesetTiles() Gets the number of tiles in the secondary tileset for the currently-opened map. :returns number: number of tiles -.. js:function:: map.getMaxSecondaryTilesetTiles() +.. js:function:: map.getNumPrimaryTilesetMetatiles() - Gets the maximum number of tiles allowed in a secondary tileset. + Gets the number of metatiles in the primary tileset for the currently-opened map. - :returns number: maximum number of tiles + :returns number: number of metatiles -.. js:function:: map.getNumTilesInMetatile() +.. js:function:: map.getNumSecondaryTilesetMetatiles() - Gets the number of tiles in a metatile. Will be either ``8`` or ``12`` depending on ``enable_triple_layer_metatiles``. + Gets the number of metatiles in the secondary tileset for the currently-opened map. - :returns number: number of tiles in a metatile + :returns number: number of metatiles -.. js:function:: map.getNumMetatileLayers() +.. js:function:: map.getPrimaryTilesetPalettePreview(paletteIndex) - Gets the number of layers in a metatiles. Will be either ``2`` or ``3`` depending on ``enable_triple_layer_metatiles``. + Gets a palette from the primary tileset of the currently-opened map. - :returns number: number of layers in a metatile + :param number paletteIndex: the palette index + :returns array: array of colors. Each color is a 3-element RGB array + +.. js:function:: map.setPrimaryTilesetPalettePreview(paletteIndex, colors, forceRedraw = true) + + Sets a palette in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap. + + :param number paletteIndex: the palette index + :param array colors: array of colors. Each color is a 3-element RGB array + :param boolean forceRedraw: Redraw the elements with the updated palette. Defaults to ``true``. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set ``redraw`` to ``true`` on the final call. + +.. js:function:: map.getPrimaryTilesetPalettesPreview() + + Gets all of the palettes from the primary tileset of the currently-opened map. + + :returns array: array of arrays of colors. Each color is a 3-element RGB array + +.. js:function:: map.setPrimaryTilesetPalettesPreview(palettes, forceRedraw = true) + + Sets all of the palettes in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap. + + :param array palettes: array of arrays of colors. Each color is a 3-element RGB array + :param boolean forceRedraw: Redraw the elements with the updated palettes. Defaults to ``true``. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set ``redraw`` to ``true`` on the final call. + +.. js:function:: map.getSecondaryTilesetPalettePreview(paletteIndex) + + Gets a palette from the secondary tileset of the currently-opened map. + + :param number paletteIndex: the palette index + :returns array: array of colors. Each color is a 3-element RGB array + +.. js:function:: map.setSecondaryTilesetPalettePreview(paletteIndex, colors, forceRedraw = true) + + Sets a palette in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap. + + :param number paletteIndex: the palette index + :param array colors: array of colors. Each color is a 3-element RGB array + :param boolean forceRedraw: Redraw the elements with the updated palette. Defaults to ``true``. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set ``redraw`` to ``true`` on the final call. + +.. js:function:: map.getSecondaryTilesetPalettesPreview() + + Gets all of the palettes from the secondary tileset of the currently-opened map. + + :returns array: array of arrays of colors. Each color is a 3-element RGB array + +.. js:function:: map.setSecondaryTilesetPalettesPreview(palettes, forceRedraw = true) + + Sets all of the palettes in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap. + + :param array palettes: array of arrays of colors. Each color is a 3-element RGB array + :param boolean forceRedraw: Redraw the elements with the updated palettes. Defaults to ``true``. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set ``redraw`` to ``true`` on the final call. + +.. js:function:: map.getPrimaryTilesetPalette(paletteIndex) + + Gets a palette from the primary tileset of the currently-opened map. + + :param number paletteIndex: the palette index + :returns array: array of colors. Each color is a 3-element RGB array + +.. js:function:: map.setPrimaryTilesetPalette(paletteIndex, colors, forceRedraw = true) + + Sets a palette in the primary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk. + + :param number paletteIndex: the palette index + :param array colors: array of colors. Each color is a 3-element RGB array + :param boolean forceRedraw: Redraw the elements with the updated palette. Defaults to ``true``. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set ``redraw`` to ``true`` on the final call. + +.. js:function:: map.getPrimaryTilesetPalettes() + + Gets all of the palettes from the primary tileset of the currently-opened map. + + :returns array: array of arrays of colors. Each color is a 3-element RGB array + +.. js:function:: map.setPrimaryTilesetPalettes(palettes, forceRedraw = true) + + Sets all of the palettes in the primary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk. + + :param array palettes: array of arrays of colors. Each color is a 3-element RGB array + :param boolean forceRedraw: Redraw the elements with the updated palettes. Defaults to ``true``. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set ``redraw`` to ``true`` on the final call. + +.. js:function:: map.getSecondaryTilesetPalette(paletteIndex) + + Gets a palette from the secondary tileset of the currently-opened map. + + :param number paletteIndex: the palette index + :returns array: array of colors. Each color is a 3-element RGB array + +.. js:function:: map.setSecondaryTilesetPalette(paletteIndex, colors, forceRedraw = true) + + Sets a palette in the secondary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk. + + :param number paletteIndex: the palette index + :param array colors: array of colors. Each color is a 3-element RGB array + :param boolean forceRedraw: Redraw the elements with the updated palette. Defaults to ``true``. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set ``redraw`` to ``true`` on the final call. + +.. js:function:: map.getSecondaryTilesetPalettes() + + Gets all of the palettes from the secondary tileset of the currently-opened map. + + :returns array: array of arrays of colors. Each color is a 3-element RGB array + +.. js:function:: map.setSecondaryTilesetPalettes(palettes, forceRedraw = true) + + Sets all of the palettes in the secondary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk. + + :param array palettes: array of arrays of colors. Each color is a 3-element RGB array + :param boolean forceRedraw: Redraw the elements with the updated palettes. Defaults to ``true``. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set ``redraw`` to ``true`` on the final call. .. js:function:: map.getMetatileLayerOrder() @@ -1225,86 +941,437 @@ The following functions are related to tilesets and how they are rendered. The f :returns array: the pixel data +Overlay Functions +^^^^^^^^^^^^^^^^^ + +The following functions are related to an overlay that is drawn on top of the map area. Text, images, and shapes can be drawn using these functions. Items can be drawn and manipulated on separate layers by specifiying a layer id. Items on higher layer ids will be drawn above those on lower layers. The visibility, opacity, position, rotation, and scale of each layer can be changed; by default all layers are visible, have an opacity of ``100``, are at position ``0,0``, an angle of ``0``, and a horizontal and vertical scale of ``1.0``. + +All overlay functions are callable via the global ``overlay`` object. + +.. js:function:: overlay.clear(layer) + + Clears and erases all previously-added overlay items on the specified layer. + + :param number layer: the layer id + +.. js:function:: overlay.clear() + + This is an overloaded function. Clears and erases all previously-added overlay items on every layer. + +.. js:function:: overlay.hide(layer) + + Hides all overlay items on the specified layer. + + :param number layer: the layer id + +.. js:function:: overlay.hide() + + This is an overloaded function. Hides all overlay items on all active layers. Layers that have not been used yet will not be hidden. + +.. js:function:: overlay.show(layer) + + Shows all overlay items on the specified layer. + + :param number layer: the layer id + +.. js:function:: overlay.show() + + This is an overloaded function. Shows all overlay items on all active layers. + +.. js:function:: overlay.getVisibility(layer = 0) + + Gets whether the specified overlay layer is currently showing or not. + + :param number layer: the layer id. Defaults to ``0`` + :returns boolean: whether the layer is showing + +.. js:function:: overlay.setVisibility(visible, layer) + + Sets the visibility of the specified overlay layer. + + :param boolean visible: whether the layer should be showing + :param number layer: the layer id + +.. js:function:: overlay.setVisibility(visible) + + This is an overloaded function. Sets the visibility of all active overlay layers. + + :param boolean visible: whether the layers should be showing + +.. js:function:: overlay.getOpacity(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:: overlay.setOpacity(opacity, layer) + + 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 + +.. js:function:: overlay.setOpacity(opacity) + + This is an overloaded function. Sets the opacity of all active overlay layers. Layers that have not been used yet will not have their opacity changed. Opacity ranges from ``0`` (invisible) to ``100`` (completely opaque). + + :param number opacity: the opacity + +.. js:function:: overlay.getHorizontalScale(layer = 0) + + Gets the horizontal scale of the specified overlay layer. ``1.0`` is normal size. + + :param number layer: the layer id. Defaults to ``0`` + :returns number: the scale + +.. js:function:: overlay.getVerticalScale(layer = 0) + + Gets the vertical scale of the specified overlay layer. ``1.0`` is normal size. + + :param number layer: the layer id. Defaults to ``0`` + :returns number: the scale + +.. js:function:: overlay.setHorizontalScale(scale, layer) + + Sets the horizontal scale of the specified overlay layer. ``1.0`` is normal size. + + :param number scale: the scale to set + :param number layer: the layer id + +.. js:function:: overlay.setHorizontalScale(scale) + + This is an overloaded function. Sets the horizontal scale of all active overlay layers. Layers that have not been used yet will not have their scale changed. ``1.0`` is normal size. + + :param number scale: the scale to set + +.. js:function:: overlay.setVerticalScale(scale, layer) + + Sets the vertical scale of the specified overlay layer. ``1.0`` is normal size. + + :param number scale: the scale to set + :param number layer: the layer id + +.. js:function:: overlay.setVerticalScale(scale) + + This is an overloaded function. Sets the vertical scale of all active overlay layers. Layers that have not been used yet will not have their scale changed. ``1.0`` is normal size. + + :param number scale: the scale to set + +.. js:function:: overlay.getRotation(layer = 0) + + Gets the angle the specified overlay layer is rotated to. + + :param number layer: the layer id. Defaults to ``0`` + :returns number: the angle the layer is rotated to + +.. js:function:: overlay.setRotation(angle, layer) + + Sets the angle the specified overlay layer is rotated to. + + :param number angle: the angle to set + :param number layer: the layer id + +.. js:function:: overlay.setRotation(angle) + + This is an overloaded function. Sets the angle that all active overlay layers are rotated to. Layers that have not been used yet will not have their angle changed. + + :param number angle: the angle to set + +.. js:function:: overlay.rotate(degrees, layer) + + Rotates the specified overlay layer. A positive number of degrees is clockwise rotation, a negative number of degrees is counterclockwise rotation. + + :param number degrees: the number of degrees to rotate + :param number layer: the layer id + +.. js:function:: overlay.rotate(degrees) + + This is an overloaded function. Rotates the all active overlay layers. Layers that have not been used yet will not be rotated. A positive number of degrees is clockwise rotation, a negative number of degrees is counterclockwise rotation. + + :param number degrees: the number of degrees to rotate + +.. js:function:: overlay.getX(layer = 0) + + Gets the x position of the specified overlay layer. + + :param number layer: the layer id. Defaults to ``0`` + :returns number: the pixel x coordinate + +.. js:function:: overlay.getY(layer = 0) + + Gets the y position of the specified overlay layer. + + :param number layer: the layer id. Defaults to ``0`` + :returns number: the pixel y coordinate + +.. js:function:: overlay.setX(x, layer) + + Sets the x position of the specified overlay layer. + + :param number x: the pixel x coordinate + :param number layer: the layer id + +.. js:function:: overlay.setX(x) + + This is an overloaded function. Sets the x position of all active overlay layers. Layers that have not been used yet will not have their position changed. + + :param number x: the pixel x coordinate + +.. js:function:: overlay.setY(y, layer) + + Sets the y position of the specified overlay layer. + + :param number y: the pixel y coordinate + :param number layer: the layer id + +.. js:function:: overlay.setY(y) + + This is an overloaded function. Sets the y position of all active overlay layers. Layers that have not been used yet will not have their position changed. + + :param number y: the pixel y coordinate + +.. js:function:: overlay.setClippingRect(x, y, width, height, layer) + + Sets the rectangular clipping region for the specifieid overlay layer. A clipping region will cause the overlay's rendering to be contained inside it. In other words, any content from the overlay layer will not be visible outside of the specified rectangle. + + :param number x: the rectangle's pixel x coordinate, 0 is the left edge of the current map. A negative value is where the left map border's region is + :param number y: the rectangle's pixel y coordinate, 0 is the top edge of the current map. A negative value is where the top map border's region is + :param number width: the rectangle's pixel width + :param number height: the rectangle's pixel height + :param number layer: the layer id + +.. js:function:: overlay.setClippingRect(x, y, width, height) + + This is an overloaded function. Sets the rectangular clipping region for all overlay layers. A clipping region will cause the overlay's rendering to be contained inside it. In other words, any content from the overlay layer will not be visible outside of the specified rectangle. + + :param number x: the rectangle's pixel x coordinate, 0 is the left edge of the current map. A negative value is where the left map border's region is + :param number y: the rectangle's pixel y coordinate, 0 is the top edge of the current map. A negative value is where the top map border's region is + :param number width: the rectangle's pixel width + :param number height: the rectangle's pixel height + +.. js:function:: overlay.clearClippingRect(layer) + + Clears any clipping for the specified overlay layer. See ``setClippingRect`` for more info about clipping. + + :param number layer: the layer id + +.. js:function:: overlay.clearClippingRect() + + Clears any clipping for all overlay layers. See ``setClippingRect`` for more info about clipping. + +.. js:function:: overlay.getPosition(layer = 0) + + Gets the position of the specified overlay layer. + + :param number layer: the layer id. Defaults to ``0`` + :returns {x, y}: the layer's pixel coordinates + +.. js:function:: overlay.setPosition(x, y, layer) + + Sets the position of the specified overlay layer. + + :param number x: the pixel x coordinate + :param number y: the pixel y coordinate + :param number layer: the layer id + +.. js:function:: overlay.setPosition(x, y) + + This is an overloaded function. Sets the position of all active overlay layers. Layers that have not been used yet will not have their position changed. + + :param number x: the pixel x coordinate + :param number y: the pixel y coordinate + +.. js:function:: overlay.move(deltaX, deltaY, layer) + + Moves the specified overlay layer. + + :param number deltaX: the number of pixels to move horizontally + :param number deltaY: the number of pixels to move vertically + :param number layer: the layer id + +.. js:function:: overlay.move(deltaX, deltaY) + + This is an overloaded function. Moves all active overlay layers. Layers that have not been used yet will not have their position changed. + + :param number deltaX: the number of pixels to move horizontally + :param number deltaY: the number of pixels to move vertically + +.. js:function:: overlay.addText(text, x, y, color = "#000000", size = 12, layer = 0) + + Adds a text item to the specified overlay layer. Text can be additionally formatted with a `limited set of HTML tags `_. Note that only text can be displayed, so text decoration like underlines or table borders will not appear. + + :param string text: the text to display + :param number x: the x pixel coordinate of the text (relative to the layer's position) + :param number y: the y pixel coordinate of the text (relative to the layer's position) + :param string color: the color of the text. Can be specified as ``"#RRGGBB"`` or ``"#AARRGGBB"``. Defaults to black. + :param number size: the font size of the text. Defaults to 12. + :param number layer: the layer id. Defaults to ``0`` + +.. js:function:: overlay.addRect(x, y, width, height, borderColor = "#000000", fillColor = "", rounding = 0, layer = 0) + + Adds a rectangle outline item to the specified overlay layer. + + :param number x: the x pixel coordinate of the rectangle's top-left corner (relative to the layer's position) + :param number y: the y pixel coordinate of the rectangle's top-left corner (relative to the layer's position) + :param number width: the pixel width of the rectangle + :param number height: the pixel height of the rectangle + :param string borderColor: the color of the rectangle's border. Can be specified as ``"#RRGGBB"`` or ``"#AARRGGBB"``. Defaults to black. + :param string fillColor: the color of the area enclosed by the rectangle. Can be specified as ``"#RRGGBB"`` or ``"#AARRGGBB"``. Defaults to transparent. + :param number rounding: the percent degree the corners will be rounded. ``0`` is rectangular, ``100`` is elliptical. Defaults to ``0`` + :param number layer: the layer id. Defaults to ``0`` + +.. js:function:: overlay.addPath(coords, borderColor = "#000000", fillColor = "", layer = 0) + + Draws a straight path on the specified layer by connecting the coordinate pairs in ``coords``. The area enclosed by the path can be colored in, and will follow the `"odd-even" fill rule `_. + + :param array coords: array of pixel coordinates to connect to create the path. Each element of the array should be an array containing an x and y pixel coordinate + :param string borderColor: the color of the path. Can be specified as ``"#RRGGBB"`` or ``"#AARRGGBB"``. Defaults to black. + :param string fillColor: the color of the area enclosed by the path. Can be specified as ``"#RRGGBB"`` or ``"#AARRGGBB"``. Defaults to transparent. + :param number layer: the layer id. Defaults to ``0`` + +.. js:function:: overlay.addPath(xCoords, yCoords, borderColor = "#000000", fillColor = "", layer = 0) + + This is an overloaded function. Draws a straight path on the specified layer by connecting the coordinates at (``xCoords``, ``yCoords``). The area enclosed by the path can be colored in, and will follow the `"odd-even" fill rule `_. + + :param array xCoords: array of x pixel coordinates to connect to create the path + :param array yCoords: array of y pixel coordinates to connect to create the path + :param string borderColor: the color of the path. Can be specified as ``"#RRGGBB"`` or ``"#AARRGGBB"``. Defaults to black. + :param string fillColor: the color of the area enclosed by the path. Can be specified as ``"#RRGGBB"`` or ``"#AARRGGBB"``. Defaults to transparent. + :param number layer: the layer id. Defaults to ``0`` + +.. js:function:: overlay.addImage(x, y, filepath, layer = 0, useCache = true) + + Adds an image item to the specified overlay layer. + + :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 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:: overlay.createImage(x, y, filepath, width = -1, height = -1, xOffset = 0, yOffset = 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 ``overlay.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 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 xOffset: the x pixel coordinate on the original image where data should be read from. Defaults to ``0`` + :param number yOffset: the y pixel coordinate on the original image where data should be read from. Defaults to ``0`` + :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`` + :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:: overlay.addTileImage(x, y, tileId, xflip, yflip, palette, setTransparency = false, layer = 0) + + Creates an image of a tile on the specified overlay layer. + + :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 number tileId: tile value for the image + :param boolean xflip: whether the tile image is flipped horizontally + :param boolean yflip: whether the tile image is flipped vertically + :param number palette: palette number for the tile image + :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`` + +.. js:function:: overlay.addTileImage(x, y, tile, setTransparency = false, layer = 0) + + Creates an image of a tile on the specified overlay layer. This is an overloaded function that takes a single tile as a JavaScript object instead of each of the tile's properties individually. + + :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 {tileId,xflip,yflip,palette} tile: the tile to create an image of + :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`` + +.. js:function:: overlay.addMetatileImage(x, y, metatileId, setTransparency = false, layer = 0) + + Creates an image of a metatile on the specified overlay layer. + + :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 number metatileId: id of the metatile to create an image of + :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`` + + Settings Functions ^^^^^^^^^^^^^^^^^^ The following functions are related to settings. -.. js:function:: map.getGridVisibility() +All settings functions are callable via the global ``utility`` object. + +.. js:function:: utility.getGridVisibility() Gets the visibility of the map grid overlay. :returns boolean: grid visibility -.. js:function:: map.setGridVisibility(visible) +.. js:function:: utility.setGridVisibility(visible) Sets the visibility of the map grid overlay. :param boolean visible: grid visibility -.. js:function:: map.getBorderVisibility() +.. js:function:: utility.getBorderVisibility() Gets the visibility of the map's border. :returns boolean: border visibility -.. js:function:: map.setBorderVisibility(visible) +.. js:function:: utility.setBorderVisibility(visible) Sets the visibility of the map's border. :param boolean visible: border visibility -.. js:function:: map.getSmartPathsEnabled() +.. js:function:: utility.getSmartPathsEnabled() Gets the toggle state of smart paths. :returns boolean: smart paths enabled -.. js:function:: map.setSmartPathsEnabled(enabled) +.. js:function:: utility.setSmartPathsEnabled(enabled) Sets the toggle state of smart paths. :param boolean enabled: smart paths enabled -.. js:function:: map.getBaseGameVersion() - - Gets the project's base game version. - - :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() +.. js:function:: utility.getCustomScripts() Gets the list of paths to custom scripts. :returns array: string array of custom scripts paths -.. js:function:: map.getMainTab() +.. js:function:: utility.getMainTab() Gets the index of the currently selected main tab. Tabs are indexed from left to right, starting at 0 (``0``: Map, ``1``: Events, ``2``: Header, ``3``: Connections, ``4``: Wild Pokemon). :returns number: current main tab index -.. js:function:: map.setMainTab(tab) +.. js:function:: utility.setMainTab(tab) Sets the currently selected main tab. Tabs are indexed from left to right, starting at 0 (``0``: Map, ``1``: Events, ``2``: Header, ``3``: Connections, ``4``: Wild Pokemon). :param number tab: index of the tab to select -.. js:function:: map.getMapViewTab() +.. js:function:: utility.getMapViewTab() - Gets the index of the currently selected map view tab. Tabs are indexed from left to right, starting at 0 (``0``: Metatiles, ``1``: Collision). + Gets the index of the currently selected map view tab. Tabs are indexed from left to right, starting at 0 (``0``: Metatiles, ``1``: Collision, ``2``: Prefabs). :returns number: current map view tab index -.. js:function:: map.setMapViewTab(tab) +.. js:function:: utility.setMapViewTab(tab) - Sets the currently selected map view tab. Tabs are indexed from left to right, starting at 0 (``0``: Metatiles, ``1``: Collision). + Sets the currently selected map view tab. Tabs are indexed from left to right, starting at 0 (``0``: Metatiles, ``1``: Collision, ``2``: Prefabs). :param number tab: index of the tab to select @@ -1313,7 +1380,9 @@ Utility Functions These are some miscellaneous functions that can be very useful when building custom scripts. -.. js:function:: map.registerAction(functionName, actionName, shortcut = "") +All utility functions are callable via the global ``utility`` object. + +.. js:function:: utility.registerAction(functionName, actionName, shortcut = "") Registers a JavaScript function to an action that can be manually triggered in Porymap's ``Tools`` menu. Optionally, a keyboard shortcut (e.g. ``"Ctrl+P"``) can also be specified, assuming it doesn't collide with any existing shortcuts used by Porymap. The function specified by ``functionName`` must have the ``export`` keyword. @@ -1321,32 +1390,32 @@ These are some miscellaneous functions that can be very useful when building cus :param string actionName: name of the action that will be displayed in the ``Tools`` menu :param string shortcut: optional keyboard shortcut -.. js:function:: map.setTimeout(func, delayMs) +.. js:function:: utility.setTimeout(func, delayMs) This behaves essentially the same as JavaScript's ``setTimeout()`` that is used in web browsers or NodeJS. The ``func`` argument is a JavaScript function (NOT the name of a function) which will be executed after a delay. This is useful for creating animations or refreshing the overlay at constant intervals. :param function func: a JavaScript function that will be executed later :param number delayMs: the number of milliseconds to wait before executing ``func`` -.. js:function:: map.log(message) +.. js:function:: utility.log(message) Logs a message to the Porymap log file with the prefix ``[INFO]``. This is useful for debugging custom scripts. :param string message: the message to log -.. js:function:: map.warn(message) +.. js:function:: utility.warn(message) Logs a message to the Porymap log file with the prefix ``[WARN]``. :param string message: the message to log -.. js:function:: map.error(message) +.. js:function:: utility.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) +.. js:function:: utility.showMessage(text, informativeText, detailedText) Displays a message box with an "Information" icon and an ``OK`` button. Execution stops while the window is open. @@ -1354,7 +1423,7 @@ These are some miscellaneous functions that can be very useful when building cus :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) +.. js:function:: utility.showWarning(text, informativeText, detailedText) Displays a message box with a "Warning" icon and an ``OK`` button. Execution stops while the window is open. @@ -1362,7 +1431,7 @@ These are some miscellaneous functions that can be very useful when building cus :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) +.. js:function:: utility.showError(text, informativeText, detailedText) Displays a message box with a "Critical" icon and an ``OK`` button. Execution stops while the window is open. @@ -1370,7 +1439,7 @@ These are some miscellaneous functions that can be very useful when building cus :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) +.. js:function:: utility.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. @@ -1379,7 +1448,7 @@ These are some miscellaneous functions that can be very useful when building cus :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) +.. js:function:: utility.getInputText(title, label, default) Displays a text input dialog with an ``OK`` and a ``Cancel`` button. Execution stops while the window is open. @@ -1388,7 +1457,7 @@ These are some miscellaneous functions that can be very useful when building cus :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) +.. js:function:: utility.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. @@ -1401,7 +1470,7 @@ These are some miscellaneous functions that can be very useful when building cus :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) +.. js:function:: utility.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. @@ -1411,3 +1480,124 @@ These are some miscellaneous functions that can be very useful when building cus :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. + +.. js:function:: utility.getMapNames() + + Gets the list of map names. + + :returns array: the list of map names + +.. js:function:: utility.getTilesetNames() + + Gets the list of tileset names. + + :returns array: the list of tileset names + +.. js:function:: utility.getPrimaryTilesetNames() + + Gets the list of primary tileset names. + + :returns array: the list of primary tileset names + +.. js:function:: utility.getSecondaryTilesetNames() + + Gets the list of secondary tileset names. + + :returns array: the list of secondary tileset names + +.. js:function:: utility.getMetatileBehaviorNames() + + Gets the list of metatile behavior names. + + :returns array: the list of metatile behavior names + +.. js:function:: utility.getSongNames() + + Gets the list of song names. + + :returns array: the list of song names + +.. js:function:: utility.getLocationNames() + + Gets the list of map location names. + + :returns array: the list of map location names + +.. js:function:: utility.getWeatherNames() + + Gets the list of weather names. + + :returns array: the list of weather names + +.. js:function:: utility.getMapTypeNames() + + Gets the list of map type names. + + :returns array: the list of map type names + +.. js:function:: utility.getBattleSceneNames() + + Gets the list of battle scene names. + + :returns array: the list of battle scene names + +.. js:function:: utility.isPrimaryTileset(tilesetName) + + Gets whether the specified tileset is a primary tileset. + + :param string tilesetName: the tileset name + :returns boolean: is a primary tileset + +.. js:function:: utility.isSecondaryTileset(tilesetName) + + Gets whether the specified tileset is a secondary tileset. + + :param string tilesetName: the tileset name + :returns boolean: is a secondary tileset + +Constants +~~~~~~~~~ + +Some constant values are provided for convenience. These are read-only properties guaranteed not to change unless a new project is opened or the current one is reloaded. + +All constants are accessible via the global ``constants`` object. + +.. js:attribute:: constants.max_primary_tiles + + The maximum number of tiles in a primary tileset. + +.. js:attribute:: constants.max_secondary_tiles + + The maximum number of tiles in a secondary tileset. + +.. js:attribute:: constants.max_primary_metatiles + + The maximum number of metatiles in a primary tileset. + +.. js:attribute:: constants.max_secondary_metatiles + + The maximum number of metatiles in a secondary tileset. + +.. js:attribute:: constants.layers_per_metatile + + The number of tile layers used in each metatile. This will either be ``2`` or ``3``, depending on the config setting ``enable_triple_layer_metatiles``. + +.. js:attribute:: constants.tiles_per_metatile + + The number of tiles in each metatile. This will either be ``8`` or ``12``, depending on the config setting ``enable_triple_layer_metatiles``. + +.. js:attribute:: constants.base_game_version + + The string value of the config setting ``base_game_version``. This will either be ``pokeruby``, ``pokefirered``, or ``pokeemerald``. + +.. js:attribute:: constants.version.major + + Porymap's major version number. For example, for Porymap version ``5.0.1`` this will be ``5``. + +.. js:attribute:: constants.version.minor + + Porymap's minor version number. For example, for Porymap version ``5.0.1`` this will be ``0``. + +.. js:attribute:: constants.version.patch + + Porymap's patch version number. For example, for Porymap version ``5.0.1`` this will be ``1``. diff --git a/docs/_sources/manual/settings-and-options.rst.txt b/docs/_sources/manual/settings-and-options.rst.txt index 4cbe3c57..2d85ed0b 100644 --- a/docs/_sources/manual/settings-and-options.rst.txt +++ b/docs/_sources/manual/settings-and-options.rst.txt @@ -10,7 +10,10 @@ A global settings file is stored in a platform-dependent location for app config A config file is also created when opening a project in porymap for the first time. It is stored in your project root as ``porymap.project.cfg``. There are several project-specific settings that are -determined by this file. +determined by this file. You may want to force commit this file so that other users will automatically have access to your project settings. + +A second config file is created for user-specific settings. It is stored in +your project root as ``porymap.user.cfg``. You should add this file to your gitignore. .. csv-table:: :header: Setting,Default,Location,Can Edit?,Description @@ -18,7 +21,7 @@ determined by this file. ``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 + ``recent_map``, , user, 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 ``window_geometry``, , global, no, For restoring window sizes @@ -30,12 +33,11 @@ determined by this file. ``show_player_view``, 0, global, yes, Display a rectangle for the GBA screen radius ``show_cursor_tile``, 0, global, yes, Display a rectangle around the hovered metatile(s) ``monitor_files``, 1, global, yes, Whether porymap will monitor changes to project files - ``region_map_dimensions``, 32x20, global, yes, The dimensions of the region map tilemap ``theme``, default, global, yes, The color theme for porymap windows and widgets ``text_editor_goto_line``, , global, yes, The command that will be executed when clicking the button next the ``Script`` combo-box. ``text_editor_open_directory``, , global, yes, The command that will be executed when clicking ``Open Project in Text Editor``. ``base_game_version``, , project, no, The base pret repo for this project - ``use_encounter_json``, 1, project, yes, Enables wild encounter table editing + ``use_encounter_json``, 1, user, yes, Enables wild encounter table editing ``use_poryscript``, 0, project, yes, Whether to open .pory files for scripts ``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 @@ -47,7 +49,15 @@ determined by this file. ``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 + ``new_map_metatile``, 1, project, yes, The metatile id that will be used to fill new maps + ``new_map_elevation``, 3, project, yes, The elevation that will be used to fill new maps + ``new_map_border_metatiles``, "``468,469,476,477`` or ``20,21,28,29``", project, yes, The list of metatile ids that will be used to fill the 2x2 border of new maps + ``default_primary_tileset``, ``gTileset_General``, project, yes, The label of the default primary tileset + ``default_secondary_tileset``, ``gTileset_Petalburg`` or ``gTileset_PalletTown``, project, yes, The label of the default secondary tileset + ``custom_scripts``, , user, yes, A list of script files to load into the scripting engine ``prefabs_filepath``, ``/prefabs.json``, project, yes, The filepath containing prefab JSON data + ``prefabs_import_prompted``, 0, project, no, Keeps track of whether or not the project was prompted for importing default prefabs + ``tilesets_have_callback``, 1, project, yes, Whether new tileset headers should have the ``callback`` field + ``tilesets_have_is_compressed``, 1, project, yes, Whether new tileset headers should have the ``isCompressed`` field Some of these settings can be toggled manually in porymap via the *Options* menu. diff --git a/docs/_sources/reference/CHANGELOG.md.txt b/docs/_sources/reference/CHANGELOG.md.txt index 8bce96f8..9f4417ab 100644 --- a/docs/_sources/reference/CHANGELOG.md.txt +++ b/docs/_sources/reference/CHANGELOG.md.txt @@ -4,40 +4,73 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project somewhat adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). The MAJOR version number is bumped when there are breaking changes in the pret projects. -The **"Breaking Changes"** listed below are changes that have been made in the decompilation projects (e.g. pokeemerald), which porymap requires in order to work properly. If porymap is used on a project that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly. +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. It also includes changes to the scripting API that may change the behavior of existing porymap scripts. If porymap is used with a project or API script that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly. ## [Unreleased] +Nothing, yet. + +## [5.0.0] - 2022-10-30 ### 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). +- Warp IDs are now treated as strings, which requires the change to `mapjson` made in [pokeemerald/#1755](https://github.com/pret/pokeemerald/pull/1755). Additionally `MAP_NONE` was renamed to `MAP_DYNAMIC`. Both changes also apply to pokefirered and pokeruby. +- Many API functions which were previously accessible via the `map` object are now accessible via one of the new objects `overlay`, `utility`, or `constants`. Some functions were renamed accordingly. See [porymap/#460](https://github.com/huderlem/porymap/pull/460) for a full list of API function name changes. +- Arguments for the API function `createImage` have changed: `xflip` and `yflip` have been replaced with `hScale` and `vScale`, and `offset` has been replaced with `xOffset` and `yOffset`. +- The API function `addFilledRect` has been removed; it's been replaced by new arguments in `addRect`: `color` has been replaced with `borderColor` and `fillColor`, and a new `rounding` argument allows ellipses to be drawn. ### 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 prefab support +- Add Cut/Copy/Paste for metatiles in the Tileset Editor. - 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 ability to export an image of the primary or secondary tileset's metatiles. +- Add new config options for customizing how new maps are filled, setting default tilesets, and whether the most recent project should be opened on launch. - Add color picker to palette editor for taking colors from the screen. +- Add new features to the scripting API, including the ability to display messages and user input windows, set the overlay's opacity, rotation, scale, and clipping, interact with map header properties and the map border, read tile pixel data, and more. ### Changed - Overhauled the region map editor, adding support for tilemaps, and significant customization. Also now supports pokefirered. +- Previous settings will be remembered in the New Map Options window. +- The Custom Attributes table for map headers and events now supports types other than strings. - 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. +- Unused metatile attribute bits 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. +- Tileset data in `headers`, `graphics`, and `metatiles` can now be parsed if written in C. +- The amount of time it takes to render the event panel has been reduced, which is most noticeable when selecting multiple events at once. - The selection is no longer reset when pasting events. The newly pasted events are selected instead. +- The currently selected event for each event group will persist between tabs. +- An object event's sprite will now render if a number is specified instead of a graphics constant. - Palette editor ui is updated a bit to allow hex and rgb value input. +- Heal location constants will no longer be deleted if they're not used in the data tables. +- The heal location prefixes `SPAWN_` and `HEAL_LOCATION_` may now be used interchangeably. +- The number and order of entries in the heal location data tables can now be changed arbitrarily, and independently of each other. +- The metatile behavior is now displayed in the bottom bar mouseover text. +- Number values are now allowed in the Tileset Editor's Metatile Behavior field. +- Removed some unnecessary error logs from the scripting API and added new useful ones. +- If any JSON data is the incorrect type Porymap will now attempt to convert it. ### Fixed +- Fix events losing their assigned script when the script autocomplete is used. +- Fix the unsaved changes indicator not disappearing when saving changes to events. +- Fix copy and paste for events not including their custom attributes. - 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 tree view arrows not displaying for custom themes. - 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 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. +- Fix drawing large amounts of text with the scripting API causing a significant drop in performance. +- Silence unnecessary error logging when parsing C defines Porymap doesn't use. +- Fix some windows like the Tileset Editor not raising to the front when reactivated. +- Fix incorrect limits on Floor Number and Border Width/Height in the New Map Options window. +- Fix Border Width/Height being set to 0 when creating a new map from an existing layout. +- Fix certain UI elements not highlighting red on some platforms. +- Fix Open Config Folder not responding +- Properly update the minimum offset for a connection when the map is changed. ## [4.5.0] - 2021-12-26 ### Added @@ -316,7 +349,8 @@ The **"Breaking Changes"** listed below are changes that have been made in the d ## [1.0.0] - 2018-10-26 This was the initial release. -[Unreleased]: https://github.com/huderlem/porymap/compare/4.5.0...HEAD +[Unreleased]: https://github.com/huderlem/porymap/compare/5.0.0...HEAD +[5.0.0]: https://github.com/huderlem/porymap/compare/4.5.0...5.0.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 diff --git a/docs/genindex.html b/docs/genindex.html index 31065c6e..b84ddbfc 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -183,12 +183,13 @@
  • Functions
    • +
  • Constants
    • @@ -205,100 +206,101 @@

    Reference

    • Changelog
        -
      • Unreleased
          +
        • Unreleased
          • +
        • 5.0.0 - 2022-10-30
          • -
        • 4.5.0 - 2021-12-26
            -
          • Added
            • -
          • Changed
            • -
          • Fixed
            • +
          • 4.5.0 - 2021-12-26
            • -
          • 4.4.0 - 2020-12-20
              -
            • Added
              • -
            • Changed
              • -
            • Fixed
              • +
            • 4.4.0 - 2020-12-20
              • -
            • 4.3.1 - 2020-07-17
                -
              • Added
                • -
              • Changed
                • -
              • Fixed
                • +
              • 4.3.1 - 2020-07-17
                • -
              • 4.3.0 - 2020-06-27
                  -
                • Added
                  • -
                • Changed
                  • -
                • Fixed
                  • +
                • 4.3.0 - 2020-06-27
                  • -
                • 4.2.0 - 2020-06-06
                    -
                  • Added
                    • -
                  • Changed
                    • -
                  • Fixed
                    • +
                  • 4.2.0 - 2020-06-06
                    • -
                  • 4.1.0 - 2020-05-18
                      -
                    • Added
                      • -
                    • Changed
                      • -
                    • Fixed
                      • +
                    • 4.1.0 - 2020-05-18
                      • -
                    • 4.0.0 - 2020-04-28
                        -
                      • Breaking Changes
                        • -
                      • Added
                        • -
                      • Changed
                        • -
                      • Fixed
                        • +
                      • 4.0.0 - 2020-04-28
                        • -
                      • 3.0.1 - 2020-03-04
                          -
                        • Fixed
                          • +
                        • 3.0.1 - 2020-03-04
                          • -
                        • 3.0.0 - 2020-03-04
                            -
                          • Breaking Changes
                            • -
                          • Added
                            • -
                          • Changed
                            • -
                          • Fixed
                            • +
                          • 3.0.0 - 2020-03-04
                            • -
                          • 2.0.0 - 2019-10-16
                              -
                            • Breaking Changes
                              • -
                            • Added
                              • -
                            • Changed
                              • -
                            • Fixed
                              • +
                            • 2.0.0 - 2019-10-16
                              • -
                            • 1.2.2 - 2019-05-16 @@ -205,100 +206,101 @@

                              Reference

                              • Changelog
                                  -
                                • Unreleased
                                    +
                                  • Unreleased
                                    • +
                                  • 5.0.0 - 2022-10-30
                                    • -
                                  • 4.5.0 - 2021-12-26
                                      -
                                    • Added
                                      • -
                                    • Changed
                                      • -
                                    • Fixed
                                      • +
                                    • 4.5.0 - 2021-12-26
                                      • -
                                    • 4.4.0 - 2020-12-20
                                        -
                                      • Added
                                        • -
                                      • Changed
                                        • -
                                      • Fixed
                                        • +
                                      • 4.4.0 - 2020-12-20
                                        • -
                                      • 4.3.1 - 2020-07-17
                                          -
                                        • Added
                                          • -
                                        • Changed
                                          • -
                                        • Fixed
                                          • +
                                        • 4.3.1 - 2020-07-17
                                          • -
                                        • 4.3.0 - 2020-06-27
                                            -
                                          • Added
                                            • -
                                          • Changed
                                            • -
                                          • Fixed
                                            • +
                                          • 4.3.0 - 2020-06-27
                                            • -
                                          • 4.2.0 - 2020-06-06
                                              -
                                            • Added
                                              • -
                                            • Changed
                                              • -
                                            • Fixed
                                              • +
                                            • 4.2.0 - 2020-06-06
                                              • -
                                            • 4.1.0 - 2020-05-18
                                                -
                                              • Added
                                                • -
                                              • Changed
                                                • -
                                              • Fixed
                                                • +
                                              • 4.1.0 - 2020-05-18
                                                • -
                                              • 4.0.0 - 2020-04-28
                                                  -
                                                • Breaking Changes
                                                  • -
                                                • Added
                                                  • -
                                                • Changed
                                                  • -
                                                • Fixed
                                                  • +
                                                • 4.0.0 - 2020-04-28
                                                  • -
                                                • 3.0.1 - 2020-03-04
                                                    -
                                                  • Fixed
                                                    • +
                                                  • 3.0.1 - 2020-03-04
                                                    • -
                                                  • 3.0.0 - 2020-03-04
                                                      -
                                                    • Breaking Changes
                                                      • -
                                                    • Added
                                                      • -
                                                    • Changed
                                                      • -
                                                    • Fixed
                                                      • +
                                                    • 3.0.0 - 2020-03-04
                                                      • -
                                                    • 2.0.0 - 2019-10-16
                                                        -
                                                      • Breaking Changes
                                                        • -
                                                      • Added
                                                        • -
                                                      • Changed
                                                        • -
                                                      • Fixed
                                                        • +
                                                      • 2.0.0 - 2019-10-16
                                                        • -
                                                      • 1.2.2 - 2019-05-16
                                                          -
                                                        • Added
                                                          • -
                                                        • Changed
                                                          • -
                                                        • Fixed
                                                          • +
                                                        • 1.2.2 - 2019-05-16
                                                          • -
                                                        • 1.2.1 - 2019-02-16
                                                            -
                                                          • Added
                                                            • -
                                                          • Fixed
                                                            • +
                                                          • 1.2.1 - 2019-02-16
                                                            • -
                                                          • 1.2.0 - 2019-02-04 @@ -206,100 +207,101 @@

                                                            Reference

                                                            • Changelog
                                                                -
                                                              • Unreleased
                                                                  +
                                                                • Unreleased
                                                                  • +
                                                                • 5.0.0 - 2022-10-30
                                                                  • -
                                                                • 4.5.0 - 2021-12-26
                                                                    -
                                                                  • Added
                                                                    • -
                                                                  • Changed
                                                                    • -
                                                                  • Fixed
                                                                    • +
                                                                  • 4.5.0 - 2021-12-26
                                                                    • -
                                                                  • 4.4.0 - 2020-12-20
                                                                      -
                                                                    • Added
                                                                      • -
                                                                    • Changed
                                                                      • -
                                                                    • Fixed
                                                                      • +
                                                                    • 4.4.0 - 2020-12-20
                                                                      • -
                                                                    • 4.3.1 - 2020-07-17
                                                                        -
                                                                      • Added
                                                                        • -
                                                                      • Changed
                                                                        • -
                                                                      • Fixed
                                                                        • +
                                                                      • 4.3.1 - 2020-07-17
                                                                        • -
                                                                      • 4.3.0 - 2020-06-27
                                                                          -
                                                                        • Added
                                                                          • -
                                                                        • Changed
                                                                          • -
                                                                        • Fixed
                                                                          • +
                                                                        • 4.3.0 - 2020-06-27
                                                                          • -
                                                                        • 4.2.0 - 2020-06-06
                                                                            -
                                                                          • Added
                                                                            • -
                                                                          • Changed
                                                                            • -
                                                                          • Fixed
                                                                            • +
                                                                          • 4.2.0 - 2020-06-06
                                                                            • -
                                                                          • 4.1.0 - 2020-05-18
                                                                              -
                                                                            • Added
                                                                              • -
                                                                            • Changed
                                                                              • -
                                                                            • Fixed
                                                                              • +
                                                                            • 4.1.0 - 2020-05-18
                                                                              • -
                                                                            • 4.0.0 - 2020-04-28
                                                                                -
                                                                              • Breaking Changes
                                                                                • -
                                                                              • Added
                                                                                • -
                                                                              • Changed
                                                                                • -
                                                                              • Fixed
                                                                                • +
                                                                              • 4.0.0 - 2020-04-28
                                                                                • -
                                                                              • 3.0.1 - 2020-03-04
                                                                                  -
                                                                                • Fixed
                                                                                  • +
                                                                                • 3.0.1 - 2020-03-04
                                                                                  • -
                                                                                • 3.0.0 - 2020-03-04
                                                                                    -
                                                                                  • Breaking Changes
                                                                                    • -
                                                                                  • Added
                                                                                    • -
                                                                                  • Changed
                                                                                    • -
                                                                                  • Fixed
                                                                                    • +
                                                                                  • 3.0.0 - 2020-03-04
                                                                                    • -
                                                                                  • 2.0.0 - 2019-10-16
                                                                                      -
                                                                                    • Breaking Changes
                                                                                      • -
                                                                                    • Added
                                                                                      • -
                                                                                    • Changed
                                                                                      • -
                                                                                    • Fixed
                                                                                      • +
                                                                                    • 2.0.0 - 2019-10-16
                                                                                      • -
                                                                                    • 1.2.2 - 2019-05-16
                                                                                        -
                                                                                      • Added
                                                                                        • -
                                                                                      • Changed
                                                                                        • -
                                                                                      • Fixed
                                                                                        • +
                                                                                      • 1.2.2 - 2019-05-16
                                                                                        • -
                                                                                      • 1.2.1 - 2019-02-16 @@ -186,93 +208,100 @@
                                                                                        • Changelog
                                                                                          • Unreleased
                                                                                            • -
                                                                                          • 4.5.0 - 2021-12-26
                                                                                              +
                                                                                            • 5.0.0 - 2022-10-30
                                                                                              • -
                                                                                            • 4.4.0 - 2020-12-20
                                                                                                +
                                                                                              • 4.5.0 - 2021-12-26
                                                                                                • -
                                                                                              • 4.3.1 - 2020-07-17
                                                                                                  +
                                                                                                • 4.4.0 - 2020-12-20
                                                                                                  • -
                                                                                                • 4.3.0 - 2020-06-27
                                                                                                    +
                                                                                                  • 4.3.1 - 2020-07-17
                                                                                                    • -
                                                                                                  • 4.2.0 - 2020-06-06
                                                                                                      +
                                                                                                    • 4.3.0 - 2020-06-27
                                                                                                      • -
                                                                                                    • 4.1.0 - 2020-05-18
                                                                                                        +
                                                                                                      • 4.2.0 - 2020-06-06
                                                                                                        • -
                                                                                                      • 4.0.0 - 2020-04-28
                                                                                                          -
                                                                                                        • Breaking Changes
                                                                                                          • +
                                                                                                        • 4.1.0 - 2020-05-18
                                                                                                          • -
                                                                                                        • 3.0.1 - 2020-03-04
                                                                                                            -
                                                                                                          • Fixed
                                                                                                            • +
                                                                                                          • 4.0.0 - 2020-04-28
                                                                                                            • -
                                                                                                          • 3.0.0 - 2020-03-04
                                                                                                              -
                                                                                                            • Breaking Changes
                                                                                                              • -
                                                                                                            • Added
                                                                                                              • -
                                                                                                            • Changed
                                                                                                              • +
                                                                                                            • 3.0.1 - 2020-03-04
                                                                                                              • -
                                                                                                            • 2.0.0 - 2019-10-16
                                                                                                                +
                                                                                                              • 3.0.0 - 2020-03-04
                                                                                                                • -
                                                                                                              • 1.2.2 - 2019-05-16
                                                                                                                  -
                                                                                                                • Added
                                                                                                                  • -
                                                                                                                • Changed
                                                                                                                  • -
                                                                                                                • Fixed
                                                                                                                  • +
                                                                                                                • 2.0.0 - 2019-10-16
                                                                                                                  • -
                                                                                                                • 1.2.1 - 2019-02-16
                                                                                                                    -
                                                                                                                  • Added
                                                                                                                    • -
                                                                                                                  • Fixed
                                                                                                                    • +
                                                                                                                  • 1.2.2 - 2019-05-16
                                                                                                                    • -
                                                                                                                  • 1.2.0 - 2019-02-04
                                                                                                                      -
                                                                                                                    • Breaking Changes
                                                                                                                      • -
                                                                                                                    • Added
                                                                                                                      • -
                                                                                                                    • Changed
                                                                                                                      • +
                                                                                                                    • 1.2.1 - 2019-02-16
                                                                                                                      • -
                                                                                                                    • 1.1.0 - 2018-12-27
                                                                                                                    • Related Projects
                                                                                                                      • @@ -347,17 +376,21 @@

                                                                                                                      Porymap relies on the user maintaining a certain level of integrity with their project files. This is a list of files that porymap reads from and writes to. Generally, if porymap writes to a file, it probably is not a good idea to edit yourself unless otherwise noted.

                                                                                                                      +

                                                                                                                      The filepath that Porymap expects for each file can be overridden with config options. The name of each config override is listed in the table, and should begin with path/. +For example if you wanted to rename include/constants/items.h to headers/defines/stuff.h, you would add path/constants_items=headers/defines/stuff.h to your project’s porymap.project.cfg file.

                                                                                                                      ----+++++ + @@ -365,168 +398,273 @@ to a file, it probably is not a good idea to edit yourself unless otherwise note + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + - + + - + + - + + - + + + + + + + + - + + - + + - + + - + + - + + - + + - + + + + + + + + - + + + + + + + + - - + + + - + + + + + + + + - + + - + + - + + - + + + + + + + + + + + + + + + + + + + + + + + + +

                                                                                                                      File Name

                                                                                                                      Read

                                                                                                                      Write

                                                                                                                      Override

                                                                                                                      Notes

                                                                                                                      data/maps/*/map.json

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      data_map_folders

                                                                                                                      data/maps/*/scripts.[inc|pory]

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      data_map_folders

                                                                                                                      for finding script labels

                                                                                                                      data/scripts/*.[inc|pory]

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      data_scripts_folders

                                                                                                                      for finding script labels

                                                                                                                      data/event_scripts.s

                                                                                                                      no

                                                                                                                      yes

                                                                                                                      data_event_scripts

                                                                                                                      only appends new script files to end of file

                                                                                                                      data/maps/map_groups.json

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      json_map_groups

                                                                                                                      data/layouts/layouts.json

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      also reads border and blockdata files listed in this file

                                                                                                                      json_layouts

                                                                                                                      data/layouts/*/[border|map].bin

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      data_layouts_folders

                                                                                                                      src/data/tilesets/headers.h

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      tilesets_headers

                                                                                                                      src/data/tilesets/graphics.h

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      tilesets_graphics

                                                                                                                      also edits palette and tile image files listed in this file

                                                                                                                      src/data/tilesets/metatiles.h

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      tilesets_metatiles

                                                                                                                      also edits metatile files listed in this file

                                                                                                                      data/tilesets/headers.inc

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      tilesets_headers_asm

                                                                                                                      only if tilesets_headers can’t be found

                                                                                                                      data/tilesets/graphics.inc

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      also edits palette and tile image files listed in this file

                                                                                                                      tilesets_graphics_asm

                                                                                                                      only if tilesets_headers can’t be found

                                                                                                                      data/tilesets/metatiles.inc

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      also edits metatile files listed in this file

                                                                                                                      tilesets_metatiles_asm

                                                                                                                      only if tilesets_headers can’t be found

                                                                                                                      src/data/wild_encounters.json

                                                                                                                      data/tilesets/[primary|secondary]/*

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      data_tilesets_folders

                                                                                                                      default tileset data location

                                                                                                                      src/data/wild_encounters.json

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      json_wild_encounters

                                                                                                                      src/data/object_events/object_event_graphics_info_pointers.h

                                                                                                                      src/data/object_events/object_event_graphics_info_pointers.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      data_obj_event_gfx_pointers

                                                                                                                      src/data/object_events/object_event_graphics_info.h

                                                                                                                      src/data/object_events/object_event_graphics_info.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      data_obj_event_gfx_info

                                                                                                                      src/data/object_events/object_event_pic_tables.h

                                                                                                                      src/data/object_events/object_event_pic_tables.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      data_obj_event_pic_tables

                                                                                                                      src/data/object_events/object_event_graphics.h

                                                                                                                      src/data/object_events/object_event_graphics.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      data_obj_event_gfx

                                                                                                                      src/data/graphics/pokemon.h

                                                                                                                      src/data/graphics/pokemon.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      data_pokemon_gfx

                                                                                                                      for pokemon sprite icons

                                                                                                                      src/data/heal_locations.h

                                                                                                                      src/data/heal_locations.h

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      data_heal_locations

                                                                                                                      src/data/region_map/region_map_entries.h

                                                                                                                      src/data/region_map/region_map_sections.json

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      json_region_map_entries

                                                                                                                      src/data/region_map/porymap_config.json

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      json_region_porymap_cfg

                                                                                                                      include/constants/global.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_global

                                                                                                                      reads OBJECT_EVENT_TEMPLATES_COUNT

                                                                                                                      include/constants/map_groups.h

                                                                                                                      no

                                                                                                                      yes

                                                                                                                      constants_map_groups

                                                                                                                      include/constants/items.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_items

                                                                                                                      include/constants/opponents.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_opponents

                                                                                                                      reads max trainers constant

                                                                                                                      include/constants/flags.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_flags

                                                                                                                      include/constants/vars.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_vars

                                                                                                                      include/constants/weather.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_weather

                                                                                                                      include/constants/heal_locations.h

                                                                                                                      no

                                                                                                                      include/constants/songs.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_songs

                                                                                                                      include/constants/pokemon.h

                                                                                                                      include/constants/heal_locations.h

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      constants_heal_locations

                                                                                                                      include/constants/pokemon.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_pokemon

                                                                                                                      reads min and max level constants

                                                                                                                      include/constants/map_types.h

                                                                                                                      include/constants/map_types.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_map_types

                                                                                                                      include/constants/trainer_types.h

                                                                                                                      include/constants/trainer_types.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_trainer_types

                                                                                                                      include/constants/secret_bases.h

                                                                                                                      include/constants/secret_bases.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_secret_bases

                                                                                                                      pokeemerald and pokeruby only

                                                                                                                      include/constants/event_object_movement.h

                                                                                                                      include/constants/event_object_movement.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_obj_event_movement

                                                                                                                      include/constants/event_objects.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_obj_events

                                                                                                                      include/constants/event_bg.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_event_bg

                                                                                                                      include/constants/region_map_sections.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_region_map_sections

                                                                                                                      include/constants/metatile_labels.h

                                                                                                                      yes

                                                                                                                      yes

                                                                                                                      constants_metatile_labels

                                                                                                                      include/constants/metatile_behaviors.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_metatile_behaviors

                                                                                                                      include/fieldmap.h

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      constants_fieldmap

                                                                                                                      reads tileset related constants

                                                                                                                      src/event_object_movement.c

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      initial_facing_table

                                                                                                                      reads gInitialMovementTypeFacingDirections

                                                                                                                      src/pokemon_icon.c

                                                                                                                      yes

                                                                                                                      no

                                                                                                                      pokemon_icon_table

                                                                                                                      reads files in gMonIconTable
                                                                                                                      diff --git a/docs/manual/scripting-capabilities.html b/docs/manual/scripting-capabilities.html index 79ec26b4..90417691 100644 --- a/docs/manual/scripting-capabilities.html +++ b/docs/manual/scripting-capabilities.html @@ -184,12 +184,13 @@
                                                                                                                    • Functions
                                                                                                                      • +
                                                                                                                    • Constants
                                                                                                                  @@ -206,100 +207,101 @@

                                                                                                                  Reference

                                                                                                                  • Changelog
                                                                                                                      -
                                                                                                                    • Unreleased
                                                                                                                        +
                                                                                                                      • Unreleased
                                                                                                                        • +
                                                                                                                      • 5.0.0 - 2022-10-30
                                                                                                                        • -
                                                                                                                      • 4.5.0 - 2021-12-26
                                                                                                                          -
                                                                                                                        • Added
                                                                                                                          • -
                                                                                                                        • Changed
                                                                                                                          • -
                                                                                                                        • Fixed
                                                                                                                          • +
                                                                                                                        • 4.5.0 - 2021-12-26
                                                                                                                          • -
                                                                                                                        • 4.4.0 - 2020-12-20
                                                                                                                            -
                                                                                                                          • Added
                                                                                                                            • -
                                                                                                                          • Changed
                                                                                                                            • -
                                                                                                                          • Fixed
                                                                                                                            • +
                                                                                                                          • 4.4.0 - 2020-12-20
                                                                                                                            • -
                                                                                                                          • 4.3.1 - 2020-07-17
                                                                                                                              -
                                                                                                                            • Added
                                                                                                                              • -
                                                                                                                            • Changed
                                                                                                                              • -
                                                                                                                            • Fixed
                                                                                                                              • +
                                                                                                                            • 4.3.1 - 2020-07-17
                                                                                                                              • -
                                                                                                                            • 4.3.0 - 2020-06-27
                                                                                                                                -
                                                                                                                              • Added
                                                                                                                                • -
                                                                                                                              • Changed
                                                                                                                                • -
                                                                                                                              • Fixed
                                                                                                                                • +
                                                                                                                              • 4.3.0 - 2020-06-27
                                                                                                                                • -
                                                                                                                              • 4.2.0 - 2020-06-06
                                                                                                                                  -
                                                                                                                                • Added
                                                                                                                                  • -
                                                                                                                                • Changed
                                                                                                                                  • -
                                                                                                                                • Fixed
                                                                                                                                  • +
                                                                                                                                • 4.2.0 - 2020-06-06
                                                                                                                                  • -
                                                                                                                                • 4.1.0 - 2020-05-18
                                                                                                                                    -
                                                                                                                                  • Added
                                                                                                                                    • -
                                                                                                                                  • Changed
                                                                                                                                    • -
                                                                                                                                  • Fixed
                                                                                                                                    • +
                                                                                                                                  • 4.1.0 - 2020-05-18
                                                                                                                                    • -
                                                                                                                                  • 4.0.0 - 2020-04-28
                                                                                                                                      -
                                                                                                                                    • Breaking Changes
                                                                                                                                      • -
                                                                                                                                    • Added
                                                                                                                                      • -
                                                                                                                                    • Changed
                                                                                                                                      • -
                                                                                                                                    • Fixed
                                                                                                                                      • +
                                                                                                                                    • 4.0.0 - 2020-04-28
                                                                                                                                      • -
                                                                                                                                    • 3.0.1 - 2020-03-04
                                                                                                                                        -
                                                                                                                                      • Fixed
                                                                                                                                        • +
                                                                                                                                      • 3.0.1 - 2020-03-04
                                                                                                                                        • -
                                                                                                                                      • 3.0.0 - 2020-03-04
                                                                                                                                          -
                                                                                                                                        • Breaking Changes
                                                                                                                                          • -
                                                                                                                                        • Added
                                                                                                                                          • -
                                                                                                                                        • Changed
                                                                                                                                          • -
                                                                                                                                        • Fixed
                                                                                                                                          • +
                                                                                                                                        • 3.0.0 - 2020-03-04
                                                                                                                                          • -
                                                                                                                                        • 2.0.0 - 2019-10-16
                                                                                                                                            -
                                                                                                                                          • Breaking Changes
                                                                                                                                            • -
                                                                                                                                          • Added
                                                                                                                                            • -
                                                                                                                                          • Changed
                                                                                                                                            • -
                                                                                                                                          • Fixed
                                                                                                                                            • +
                                                                                                                                          • 2.0.0 - 2019-10-16
                                                                                                                                            • -
                                                                                                                                          • 1.2.2 - 2019-05-16
                                                                                                                                              -
                                                                                                                                            • Added
                                                                                                                                              • -
                                                                                                                                            • Changed
                                                                                                                                              • -
                                                                                                                                            • Fixed
                                                                                                                                              • +
                                                                                                                                            • 1.2.2 - 2019-05-16
                                                                                                                                              • -
                                                                                                                                            • 1.2.1 - 2019-02-16
                                                                                                                                                -
                                                                                                                                              • Added
                                                                                                                                                • -
                                                                                                                                              • Fixed
                                                                                                                                                • +
                                                                                                                                              • 1.2.1 - 2019-02-16
                                                                                                                                                • -
                                                                                                                                              • 1.2.0 - 2019-02-04
                                                                                                                                                  -
                                                                                                                                                • Breaking Changes
                                                                                                                                                  • -
                                                                                                                                                • Added
                                                                                                                                                  • -
                                                                                                                                                • Changed
                                                                                                                                                  • -
                                                                                                                                                • Fixed
                                                                                                                                                  • +
                                                                                                                                                • 1.2.0 - 2019-02-04
                                                                                                                                                  • -
                                                                                                                                                • 1.1.0 - 2018-12-27
                                                                                                                                                • Related Projects
                                                                                                                                                  • @@ -418,9 +420,9 @@

                                                                                                                                                  Let’s test the script out by re-launching Porymap. If we try to paint grass on the map, we should see our script inserting a nice randomized grass pattern.

                                                                                                                                                  -
                                                                                                                                                  +
                                                                                                                                                  Grass-Randomizing Script -

                                                                                                                                                  Grass-Randomizing Script

                                                                                                                                                  +

                                                                                                                                                  Grass-Randomizing Script

                                                                                                                                                  @@ -432,7 +434,7 @@ // Porymap callback when project is opened. export function onProjectOpened(projectPath) { -map.registerAction("applyNightTint", "View Night Tint", "T") + utility.registerAction("applyNightTint", "View Night Tint", "T") }
                                                                                                                                                  @@ -610,7 +612,7 @@
                                                                                                                                                  onMapViewTabChanged(oldTab, newTab)
                                                                                                                                                  -

                                                                                                                                                  Called when the selected tab in the map view tab bar is changed. Tabs are indexed from left to right, starting at 0 (0: Metatiles, 1: Collision).

                                                                                                                                                  +

                                                                                                                                                  Called when the selected tab in the map view tab bar is changed. Tabs are indexed from left to right, starting at 0 (0: Metatiles, 1: Collision, 2: Prefabs).

                                                                                                                                                  Arguments
                                                                                                                                                    @@ -637,10 +639,10 @@

                                                                                                                                                    Functions

                                                                                                                                                    -

                                                                                                                                                    All scripting functions are callable via the global map object.

                                                                                                                                                    Map Editing Functions

                                                                                                                                                    The following functions are related to editing the map’s blocks or retrieving information about them.

                                                                                                                                                    +

                                                                                                                                                    All map editing functions are callable via the global map object.

                                                                                                                                                    map.getBlock(x, y)
                                                                                                                                                    @@ -1090,6 +1092,7 @@

                                                                                                                                                    Map Header Editing Functions

                                                                                                                                                    The following functions are related to reading/writing the map’s header properties.

                                                                                                                                                    +

                                                                                                                                                    All map header functions are callable via the global map object.

                                                                                                                                                    map.getSong()
                                                                                                                                                    @@ -1354,714 +1357,11 @@
                                                                                                                                                  - -
                                                                                                                                                  -

                                                                                                                                                  Map Overlay Functions

                                                                                                                                                  -

                                                                                                                                                  The following functions are related to an overlay that is drawn on top of the map area. Text, images, and shapes can be drawn using these functions. Items can be drawn and manipulated on separate layers by specifiying a layer id. Items on higher layer ids will be drawn above those on lower layers. If no layer is specified they will be added to the default layer 0. The visibility and position of each layer can be changed; by default all layers are visible, and their position is 0,0.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -map.clearOverlay(layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Clears and erases all overlay items on the specified layer that were previously-added to the map.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.clearOverlays()
                                                                                                                                                  -

                                                                                                                                                  Clears and erases all overlay items that were previously-added to the map.

                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.hideOverlay(layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Hides all overlay items on the specified layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.hideOverlays()
                                                                                                                                                  -

                                                                                                                                                  Hides all overlay items on all active layers.

                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.showOverlay(layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Shows all overlay items on the specified layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.showOverlays()
                                                                                                                                                  -

                                                                                                                                                  Shows all overlay items on all active layers.

                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getOverlayVisibility(layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Gets whether the specified overlay layer is currently showing or not.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns boolean
                                                                                                                                                  -

                                                                                                                                                  whether the layer is showing

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setOverlayVisibility(visible, layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Sets the visibility of the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • visible (boolean) – whether the layer should be showing

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setOverlaysVisibility(visible)
                                                                                                                                                  -

                                                                                                                                                  Sets the visibility of all active overlay layers.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • visible (boolean) – whether the layers should be showing

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getOverlayOpacity(layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Gets the opacity of the specified overlay layer. Opacity ranges from 0 (invisible) to 100 (completely opaque).

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns number
                                                                                                                                                  -

                                                                                                                                                  the opacity

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setOverlayOpacity(opacity, layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Sets the opacity of the specified overlay layer. Opacity ranges from 0 (invisible) to 100 (completely opaque).

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • opacity (number) – the opacity

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setOverlaysOpacity(opacity)
                                                                                                                                                  -

                                                                                                                                                  Sets the opacity of all active overlay layers. Opacity ranges from 0 (invisible) to 100 (completely opaque).

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • opacity (number) – the opacity

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getOverlayX(layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Gets the x position of the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns number
                                                                                                                                                  -

                                                                                                                                                  the pixel x coordinate

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getOverlayY(layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Gets the y position of the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns number
                                                                                                                                                  -

                                                                                                                                                  the pixel y coordinate

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setOverlayX(x, layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Sets the x position of the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • x (number) – the pixel x coordinate

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setOverlayY(y, layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Sets the y position of the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • y (number) – the pixel y coordinate

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setOverlaysX(x)
                                                                                                                                                  -

                                                                                                                                                  Sets the x position of all active overlay layers.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • x (number) – the pixel x coordinate

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setOverlaysY(y)
                                                                                                                                                  -

                                                                                                                                                  Sets the y position of all active overlay layers.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • y (number) – the pixel y coordinate

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getOverlayPosition(layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Gets the position of the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns {x, y}
                                                                                                                                                  -

                                                                                                                                                  the layer’s pixel coordinates

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setOverlayPosition(x, y, layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Sets the position of the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • x (number) – the pixel x coordinate

                                                                                                                                                    • -

                                                                                                                                                  • y (number) – the pixel y coordinate

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setOverlaysPosition(x, y)
                                                                                                                                                  -

                                                                                                                                                  Sets the position of all active overlay layers.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • x (number) – the pixel x coordinate

                                                                                                                                                    • -

                                                                                                                                                  • y (number) – the pixel y coordinate

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.moveOverlay(deltaX, deltaY, layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Moves the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • deltaX (number) – the number of pixels to move horizontally

                                                                                                                                                    • -

                                                                                                                                                  • deltaY (number) – the number of pixels to move vertically

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.moveOverlays(deltaX, deltaY)
                                                                                                                                                  -

                                                                                                                                                  Moves all active overlay layers.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • deltaX (number) – the number of pixels to move horizontally

                                                                                                                                                    • -

                                                                                                                                                  • deltaY (number) – the number of pixels to move vertically

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.addText(text, x, y, color = "#000000", size = 12, layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Adds a text item to the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • text (string) – the text to display

                                                                                                                                                    • -

                                                                                                                                                  • x (number) – the x pixel coordinate of the text (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • y (number) – the y pixel coordinate of the text (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • color (string) – the color of the text. Can be specified as “#RRGGBB” or “#AARRGGBB”. Defaults to black.

                                                                                                                                                    • -

                                                                                                                                                  • size (number) – the font size of the text. Defaults to 12.

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.addRect(x, y, width, height, color = "#000000", layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Adds a rectangle outline item to the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • x (number) – the x pixel coordinate of the rectangle’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • y (number) – the y pixel coordinate of the rectangle’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • width (number) – the pixel width of the rectangle

                                                                                                                                                    • -

                                                                                                                                                  • height (number) – the pixel height of the rectangle

                                                                                                                                                    • -

                                                                                                                                                  • color (string) – the color of the rectangle. Can be specified as “#RRGGBB” or “#AARRGGBB”. Defaults to black.

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.addFilledRect(x, y, width, height, color = "#000000", layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Adds a filled rectangle item to the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • x (number) – the x pixel coordinate of the rectangle’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • y (number) – the y pixel coordinate of the rectangle’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • width (number) – the pixel width of the rectangle

                                                                                                                                                    • -

                                                                                                                                                  • height (number) – the pixel height of the rectangle

                                                                                                                                                    • -

                                                                                                                                                  • color (string) – the color of the rectangle. Can be specified as “#RRGGBB” or “#AARRGGBB”. Defaults to black.

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.addImage(x, y, filepath, layer = 0, useCache = true)
                                                                                                                                                  -

                                                                                                                                                  Adds an image item to the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • x (number) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • y (number) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • filepath (string) – the image’s filepath

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -

                                                                                                                                                  • useCache (boolean) – 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.

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

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • x (number) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • y (number) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • filepath (string) – the image’s filepath

                                                                                                                                                    • -

                                                                                                                                                  • width (number) – 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

                                                                                                                                                    • -

                                                                                                                                                  • height (number) – 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

                                                                                                                                                    • -

                                                                                                                                                  • offset (number) – the pixel offset into the original image where data should be read from. Defaults to 0

                                                                                                                                                    • -

                                                                                                                                                  • hScale (number) – the horizontal scale for the image. Negative values will be a horizontal flip of the original image. Defaults to 1

                                                                                                                                                    • -

                                                                                                                                                  • vScale (number) – the vertical scale for the image. Negative values will be a vertical flip of the original image. Defaults to 1

                                                                                                                                                    • -

                                                                                                                                                  • paletteId (number) – the id of which currently loaded tileset palette to use for the image. If -1, use the original image’s palette. Defaults to -1

                                                                                                                                                    • -

                                                                                                                                                  • setTransparency (boolean) – whether the color at index 0 should be overwritten with transparent pixels. Defaults to false

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -

                                                                                                                                                  • useCache (boolean) – 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.

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.addTileImage(x, y, tileId, xflip, yflip, palette, setTransparency = false, layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Creates an image of a tile on the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • x (number) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • y (number) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • tileId (number) – tile value for the image

                                                                                                                                                    • -

                                                                                                                                                  • xflip (boolean) – whether the tile image is flipped horizontally

                                                                                                                                                    • -

                                                                                                                                                  • yflip (boolean) – whether the tile image is flipped vertically

                                                                                                                                                    • -

                                                                                                                                                  • palette (number) – palette number for the tile image

                                                                                                                                                    • -

                                                                                                                                                  • setTransparency (boolean) – whether the color at index 0 should be overwritten with transparent pixels. Defaults to false

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.addTileImage(x, y, tile, setTransparency = false, layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Creates an image of a tile on the specified overlay layer. This is an overloaded function that takes a single tile as a JavaScript object instead of each of the tile’s properties individually.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • x (number) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • y (number) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • tile ({tileId,xflip,yflip,palette}) – the tile to create an image of

                                                                                                                                                    • -

                                                                                                                                                  • setTransparency (boolean) – whether the color at index 0 should be overwritten with transparent pixels. Defaults to false

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.addMetatileImage(x, y, metatileId, setTransparency = false, layer = 0)
                                                                                                                                                  -

                                                                                                                                                  Creates an image of a metatile on the specified overlay layer.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • x (number) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • y (number) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • -

                                                                                                                                                  • metatileId (number) – id of the metatile to create an image of

                                                                                                                                                    • -

                                                                                                                                                  • setTransparency (boolean) – whether the color at index 0 should be overwritten with transparent pixels. Defaults to false

                                                                                                                                                    • -

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  Tileset Functions

                                                                                                                                                  The following functions are related to tilesets and how they are rendered. The functions with “preview” in their name operate on a “fake” version of the palette colors. This means that changing these “preview” colors won’t affect the actual tileset colors in the project. A good use of the “preview” palettes would be Day/Night tints, for example.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -map.getPrimaryTilesetPalettePreview(paletteIndex)
                                                                                                                                                  -

                                                                                                                                                  Gets a palette from the primary tileset of the currently-opened map.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns array
                                                                                                                                                  -

                                                                                                                                                  array of colors. Each color is a 3-element RGB array

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setPrimaryTilesetPalettePreview(paletteIndex, colors)
                                                                                                                                                  -

                                                                                                                                                  Sets a palette in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • -

                                                                                                                                                  • colors (array) – array of colors. Each color is a 3-element RGB array

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getPrimaryTilesetPalettesPreview()
                                                                                                                                                  -

                                                                                                                                                  Gets all of the palettes from the primary tileset of the currently-opened map.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns array
                                                                                                                                                  -

                                                                                                                                                  array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setPrimaryTilesetPalettesPreview(palettes)
                                                                                                                                                  -

                                                                                                                                                  Sets all of the palettes in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • palettes (array) – array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getSecondaryTilesetPalettePreview(paletteIndex)
                                                                                                                                                  -

                                                                                                                                                  Gets a palette from the secondary tileset of the currently-opened map.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns array
                                                                                                                                                  -

                                                                                                                                                  array of colors. Each color is a 3-element RGB array

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setSecondaryTilesetPalettePreview(paletteIndex, colors)
                                                                                                                                                  -

                                                                                                                                                  Sets a palette in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • -

                                                                                                                                                  • colors (array) – array of colors. Each color is a 3-element RGB array

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getSecondaryTilesetPalettesPreview()
                                                                                                                                                  -

                                                                                                                                                  Gets all of the palettes from the secondary tileset of the currently-opened map.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns array
                                                                                                                                                  -

                                                                                                                                                  array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setSecondaryTilesetPalettesPreview(palettes)
                                                                                                                                                  -

                                                                                                                                                  Sets all of the palettes in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • palettes (array) – array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getPrimaryTilesetPalette(paletteIndex)
                                                                                                                                                  -

                                                                                                                                                  Gets a palette from the primary tileset of the currently-opened map.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns array
                                                                                                                                                  -

                                                                                                                                                  array of colors. Each color is a 3-element RGB array

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setPrimaryTilesetPalette(paletteIndex, colors)
                                                                                                                                                  -

                                                                                                                                                  Sets a palette in the primary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • -

                                                                                                                                                  • colors (array) – array of colors. Each color is a 3-element RGB array

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getPrimaryTilesetPalettes()
                                                                                                                                                  -

                                                                                                                                                  Gets all of the palettes from the primary tileset of the currently-opened map.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns array
                                                                                                                                                  -

                                                                                                                                                  array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setPrimaryTilesetPalettes(palettes)
                                                                                                                                                  -

                                                                                                                                                  Sets all of the palettes in the primary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • palettes (array) – array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getSecondaryTilesetPalette(paletteIndex)
                                                                                                                                                  -

                                                                                                                                                  Gets a palette from the secondary tileset of the currently-opened map.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns array
                                                                                                                                                  -

                                                                                                                                                  array of colors. Each color is a 3-element RGB array

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setSecondaryTilesetPalette(paletteIndex, colors)
                                                                                                                                                  -

                                                                                                                                                  Sets a palette in the secondary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • -

                                                                                                                                                  • colors (array) – array of colors. Each color is a 3-element RGB array

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getSecondaryTilesetPalettes()
                                                                                                                                                  -

                                                                                                                                                  Gets all of the palettes from the secondary tileset of the currently-opened map.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns array
                                                                                                                                                  -

                                                                                                                                                  array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.setSecondaryTilesetPalettes(palettes)
                                                                                                                                                  -

                                                                                                                                                  Sets all of the palettes in the secondary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • palettes (array) – array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.isPrimaryTileset(tilesetName)
                                                                                                                                                  -

                                                                                                                                                  Gets whether the specified tileset is a primary tileset.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • tilesetName (string) – the tileset name

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns boolean
                                                                                                                                                  -

                                                                                                                                                  is a primary tileset

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.isSecondaryTileset(tilesetName)
                                                                                                                                                  -

                                                                                                                                                  Gets whether the specified tileset is a secondary tileset.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Arguments
                                                                                                                                                  -
                                                                                                                                                    -

                                                                                                                                                  • tilesetName (string) – the tileset name

                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns boolean
                                                                                                                                                  -

                                                                                                                                                  is a secondary tileset

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - +

                                                                                                                                                  All tileset functions are callable via the global map object.

                                                                                                                                                  map.getPrimaryTileset()
                                                                                                                                                  @@ -2110,50 +1410,6 @@
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -map.getNumPrimaryTilesetMetatiles()
                                                                                                                                                  -

                                                                                                                                                  Gets the number of metatiles in the primary tileset for the currently-opened map.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns number
                                                                                                                                                  -

                                                                                                                                                  number of metatiles

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getMaxPrimaryTilesetMetatiles()
                                                                                                                                                  -

                                                                                                                                                  Gets the maximum number of metatiles allowed in a primary tileset.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns number
                                                                                                                                                  -

                                                                                                                                                  maximum number of metatiles

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getNumSecondaryTilesetMetatiles()
                                                                                                                                                  -

                                                                                                                                                  Gets the number of metatiles in the secondary tileset for the currently-opened map.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns number
                                                                                                                                                  -

                                                                                                                                                  number of metatiles

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getMaxSecondaryTilesetMetatiles()
                                                                                                                                                  -

                                                                                                                                                  Gets the maximum number of metatiles allowed in a secondary tileset.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns number
                                                                                                                                                  -

                                                                                                                                                  maximum number of metatiles

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  map.getNumPrimaryTilesetTiles()
                                                                                                                                                  @@ -2165,17 +1421,6 @@
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -map.getMaxPrimaryTilesetTiles()
                                                                                                                                                  -

                                                                                                                                                  Gets the maximum number of tiles allowed in a primary tileset.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns number
                                                                                                                                                  -

                                                                                                                                                  maximum number of tiles

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  map.getNumSecondaryTilesetTiles()
                                                                                                                                                  @@ -2188,34 +1433,247 @@
                                                                                                                                                  -
                                                                                                                                                  -map.getMaxSecondaryTilesetTiles()
                                                                                                                                                  -

                                                                                                                                                  Gets the maximum number of tiles allowed in a secondary tileset.

                                                                                                                                                  +
                                                                                                                                                  +map.getNumPrimaryTilesetMetatiles()
                                                                                                                                                  +

                                                                                                                                                  Gets the number of metatiles in the primary tileset for the currently-opened map.

                                                                                                                                                  Returns number
                                                                                                                                                  -

                                                                                                                                                  maximum number of tiles

                                                                                                                                                  +

                                                                                                                                                  number of metatiles

                                                                                                                                                  -
                                                                                                                                                  -map.getNumTilesInMetatile()
                                                                                                                                                  -

                                                                                                                                                  Gets the number of tiles in a metatile. Will be either 8 or 12 depending on enable_triple_layer_metatiles.

                                                                                                                                                  +
                                                                                                                                                  +map.getNumSecondaryTilesetMetatiles()
                                                                                                                                                  +

                                                                                                                                                  Gets the number of metatiles in the secondary tileset for the currently-opened map.

                                                                                                                                                  Returns number
                                                                                                                                                  -

                                                                                                                                                  number of tiles in a metatile

                                                                                                                                                  +

                                                                                                                                                  number of metatiles

                                                                                                                                                  -
                                                                                                                                                  -map.getNumMetatileLayers()
                                                                                                                                                  -

                                                                                                                                                  Gets the number of layers in a metatiles. Will be either 2 or 3 depending on enable_triple_layer_metatiles.

                                                                                                                                                  +
                                                                                                                                                  +map.getPrimaryTilesetPalettePreview(paletteIndex)
                                                                                                                                                  +

                                                                                                                                                  Gets a palette from the primary tileset of the currently-opened map.

                                                                                                                                                  -
                                                                                                                                                  Returns number
                                                                                                                                                  -

                                                                                                                                                  number of layers in a metatile

                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns array
                                                                                                                                                  +

                                                                                                                                                  array of colors. Each color is a 3-element RGB array

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.setPrimaryTilesetPalettePreview(paletteIndex, colors, forceRedraw = true)
                                                                                                                                                  +

                                                                                                                                                  Sets a palette in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • +

                                                                                                                                                  • colors (array) – array of colors. Each color is a 3-element RGB array

                                                                                                                                                    • +

                                                                                                                                                  • forceRedraw (boolean) – Redraw the elements with the updated palette. Defaults to true. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set redraw to true on the final call.

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.getPrimaryTilesetPalettesPreview()
                                                                                                                                                  +

                                                                                                                                                  Gets all of the palettes from the primary tileset of the currently-opened map.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns array
                                                                                                                                                  +

                                                                                                                                                  array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.setPrimaryTilesetPalettesPreview(palettes, forceRedraw = true)
                                                                                                                                                  +

                                                                                                                                                  Sets all of the palettes in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • palettes (array) – array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                    • +

                                                                                                                                                  • forceRedraw (boolean) – Redraw the elements with the updated palettes. Defaults to true. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set redraw to true on the final call.

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.getSecondaryTilesetPalettePreview(paletteIndex)
                                                                                                                                                  +

                                                                                                                                                  Gets a palette from the secondary tileset of the currently-opened map.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns array
                                                                                                                                                  +

                                                                                                                                                  array of colors. Each color is a 3-element RGB array

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.setSecondaryTilesetPalettePreview(paletteIndex, colors, forceRedraw = true)
                                                                                                                                                  +

                                                                                                                                                  Sets a palette in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • +

                                                                                                                                                  • colors (array) – array of colors. Each color is a 3-element RGB array

                                                                                                                                                    • +

                                                                                                                                                  • forceRedraw (boolean) – Redraw the elements with the updated palette. Defaults to true. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set redraw to true on the final call.

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.getSecondaryTilesetPalettesPreview()
                                                                                                                                                  +

                                                                                                                                                  Gets all of the palettes from the secondary tileset of the currently-opened map.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns array
                                                                                                                                                  +

                                                                                                                                                  array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.setSecondaryTilesetPalettesPreview(palettes, forceRedraw = true)
                                                                                                                                                  +

                                                                                                                                                  Sets all of the palettes in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors–it only displays these colors in the map-editing area of Porymap.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • palettes (array) – array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                    • +

                                                                                                                                                  • forceRedraw (boolean) – Redraw the elements with the updated palettes. Defaults to true. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set redraw to true on the final call.

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.getPrimaryTilesetPalette(paletteIndex)
                                                                                                                                                  +

                                                                                                                                                  Gets a palette from the primary tileset of the currently-opened map.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns array
                                                                                                                                                  +

                                                                                                                                                  array of colors. Each color is a 3-element RGB array

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.setPrimaryTilesetPalette(paletteIndex, colors, forceRedraw = true)
                                                                                                                                                  +

                                                                                                                                                  Sets a palette in the primary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • +

                                                                                                                                                  • colors (array) – array of colors. Each color is a 3-element RGB array

                                                                                                                                                    • +

                                                                                                                                                  • forceRedraw (boolean) – Redraw the elements with the updated palette. Defaults to true. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set redraw to true on the final call.

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.getPrimaryTilesetPalettes()
                                                                                                                                                  +

                                                                                                                                                  Gets all of the palettes from the primary tileset of the currently-opened map.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns array
                                                                                                                                                  +

                                                                                                                                                  array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.setPrimaryTilesetPalettes(palettes, forceRedraw = true)
                                                                                                                                                  +

                                                                                                                                                  Sets all of the palettes in the primary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • palettes (array) – array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                    • +

                                                                                                                                                  • forceRedraw (boolean) – Redraw the elements with the updated palettes. Defaults to true. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set redraw to true on the final call.

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.getSecondaryTilesetPalette(paletteIndex)
                                                                                                                                                  +

                                                                                                                                                  Gets a palette from the secondary tileset of the currently-opened map.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns array
                                                                                                                                                  +

                                                                                                                                                  array of colors. Each color is a 3-element RGB array

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.setSecondaryTilesetPalette(paletteIndex, colors, forceRedraw = true)
                                                                                                                                                  +

                                                                                                                                                  Sets a palette in the secondary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • paletteIndex (number) – the palette index

                                                                                                                                                    • +

                                                                                                                                                  • colors (array) – array of colors. Each color is a 3-element RGB array

                                                                                                                                                    • +

                                                                                                                                                  • forceRedraw (boolean) – Redraw the elements with the updated palette. Defaults to true. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set redraw to true on the final call.

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.getSecondaryTilesetPalettes()
                                                                                                                                                  +

                                                                                                                                                  Gets all of the palettes from the secondary tileset of the currently-opened map.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns array
                                                                                                                                                  +

                                                                                                                                                  array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +map.setSecondaryTilesetPalettes(palettes, forceRedraw = true)
                                                                                                                                                  +

                                                                                                                                                  Sets all of the palettes in the secondary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • palettes (array) – array of arrays of colors. Each color is a 3-element RGB array

                                                                                                                                                    • +

                                                                                                                                                  • forceRedraw (boolean) – Redraw the elements with the updated palettes. Defaults to true. Redrawing the elements that use palettes is expensive, so it can be useful to batch together many calls to palette functions and only set redraw to true on the final call.

                                                                                                                                                    • +
                                                                                                                                                  @@ -2510,8 +1968,8 @@
                                                                                                                                                  -
                                                                                                                                                  -map.setMetatileTile(metatileId, tileIndex, tile, forceRedraw = true)
                                                                                                                                                  +
                                                                                                                                                  +map.setMetatileTile(metatileId, tileIndex, tile, forceRedraw = true)

                                                                                                                                                  Sets the tile at the specified index of the metatile. This is an overloaded function that takes a single tile as a JavaScript object instead of each of the tile’s properties individually.

                                                                                                                                                  Warning: This function writes directly to the tileset. There is no undo for this.

                                                                                                                                                  @@ -2548,8 +2006,8 @@
                                                                                                                                                  -
                                                                                                                                                  -map.setMetatileTiles(metatileId, tiles, tileStart = 0, tileEnd = -1, forceRedraw = true)
                                                                                                                                                  +
                                                                                                                                                  +map.setMetatileTiles(metatileId, tiles, tileStart = 0, tileEnd = -1, forceRedraw = true)

                                                                                                                                                  Sets the tiles in the specified range of the metatile. This is an overloaded function that takes an array of tiles as JavaScript objects instead of each of the tile properties individually.

                                                                                                                                                  Warning: This function writes directly to the tileset. There is no undo for this.

                                                                                                                                                  @@ -2576,13 +2034,697 @@
                                                                                                                                                  + +
                                                                                                                                                  +

                                                                                                                                                  Overlay Functions

                                                                                                                                                  +

                                                                                                                                                  The following functions are related to an overlay that is drawn on top of the map area. Text, images, and shapes can be drawn using these functions. Items can be drawn and manipulated on separate layers by specifiying a layer id. Items on higher layer ids will be drawn above those on lower layers. The visibility, opacity, position, rotation, and scale of each layer can be changed; by default all layers are visible, have an opacity of 100, are at position 0,0, an angle of 0, and a horizontal and vertical scale of 1.0.

                                                                                                                                                  +

                                                                                                                                                  All overlay functions are callable via the global overlay object.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +overlay.clear(layer)
                                                                                                                                                  +

                                                                                                                                                  Clears and erases all previously-added overlay items on the specified layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.clear()
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Clears and erases all previously-added overlay items on every layer.

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.hide(layer)
                                                                                                                                                  +

                                                                                                                                                  Hides all overlay items on the specified layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.hide()
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Hides all overlay items on all active layers. Layers that have not been used yet will not be hidden.

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.show(layer)
                                                                                                                                                  +

                                                                                                                                                  Shows all overlay items on the specified layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.show()
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Shows all overlay items on all active layers.

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.getVisibility(layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Gets whether the specified overlay layer is currently showing or not.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns boolean
                                                                                                                                                  +

                                                                                                                                                  whether the layer is showing

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setVisibility(visible, layer)
                                                                                                                                                  +

                                                                                                                                                  Sets the visibility of the specified overlay layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • visible (boolean) – whether the layer should be showing

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setVisibility(visible)
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Sets the visibility of all active overlay layers.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • visible (boolean) – whether the layers should be showing

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.getOpacity(layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Gets the opacity of the specified overlay layer. Opacity ranges from 0 (invisible) to 100 (completely opaque).

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns number
                                                                                                                                                  +

                                                                                                                                                  the opacity

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setOpacity(opacity, layer)
                                                                                                                                                  +

                                                                                                                                                  Sets the opacity of the specified overlay layer. Opacity ranges from 0 (invisible) to 100 (completely opaque).

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • opacity (number) – the opacity

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setOpacity(opacity)
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Sets the opacity of all active overlay layers. Layers that have not been used yet will not have their opacity changed. Opacity ranges from 0 (invisible) to 100 (completely opaque).

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • opacity (number) – the opacity

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.getHorizontalScale(layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Gets the horizontal scale of the specified overlay layer. 1.0 is normal size.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns number
                                                                                                                                                  +

                                                                                                                                                  the scale

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.getVerticalScale(layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Gets the vertical scale of the specified overlay layer. 1.0 is normal size.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns number
                                                                                                                                                  +

                                                                                                                                                  the scale

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setHorizontalScale(scale, layer)
                                                                                                                                                  +

                                                                                                                                                  Sets the horizontal scale of the specified overlay layer. 1.0 is normal size.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • scale (number) – the scale to set

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setHorizontalScale(scale)
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Sets the horizontal scale of all active overlay layers. Layers that have not been used yet will not have their scale changed. 1.0 is normal size.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • scale (number) – the scale to set

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setVerticalScale(scale, layer)
                                                                                                                                                  +

                                                                                                                                                  Sets the vertical scale of the specified overlay layer. 1.0 is normal size.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • scale (number) – the scale to set

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setVerticalScale(scale)
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Sets the vertical scale of all active overlay layers. Layers that have not been used yet will not have their scale changed. 1.0 is normal size.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • scale (number) – the scale to set

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.getRotation(layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Gets the angle the specified overlay layer is rotated to.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns number
                                                                                                                                                  +

                                                                                                                                                  the angle the layer is rotated to

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setRotation(angle, layer)
                                                                                                                                                  +

                                                                                                                                                  Sets the angle the specified overlay layer is rotated to.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • angle (number) – the angle to set

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setRotation(angle)
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Sets the angle that all active overlay layers are rotated to. Layers that have not been used yet will not have their angle changed.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • angle (number) – the angle to set

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.rotate(degrees, layer)
                                                                                                                                                  +

                                                                                                                                                  Rotates the specified overlay layer. A positive number of degrees is clockwise rotation, a negative number of degrees is counterclockwise rotation.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • degrees (number) – the number of degrees to rotate

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.rotate(degrees)
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Rotates the all active overlay layers. Layers that have not been used yet will not be rotated. A positive number of degrees is clockwise rotation, a negative number of degrees is counterclockwise rotation.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • degrees (number) – the number of degrees to rotate

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.getX(layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Gets the x position of the specified overlay layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns number
                                                                                                                                                  +

                                                                                                                                                  the pixel x coordinate

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.getY(layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Gets the y position of the specified overlay layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns number
                                                                                                                                                  +

                                                                                                                                                  the pixel y coordinate

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setX(x, layer)
                                                                                                                                                  +

                                                                                                                                                  Sets the x position of the specified overlay layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • x (number) – the pixel x coordinate

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setX(x)
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Sets the x position of all active overlay layers. Layers that have not been used yet will not have their position changed.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • x (number) – the pixel x coordinate

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setY(y, layer)
                                                                                                                                                  +

                                                                                                                                                  Sets the y position of the specified overlay layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • y (number) – the pixel y coordinate

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setY(y)
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Sets the y position of all active overlay layers. Layers that have not been used yet will not have their position changed.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • y (number) – the pixel y coordinate

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setClippingRect(x, y, width, height, layer)
                                                                                                                                                  +

                                                                                                                                                  Sets the rectangular clipping region for the specifieid overlay layer. A clipping region will cause the overlay’s rendering to be contained inside it. In other words, any content from the overlay layer will not be visible outside of the specified rectangle.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • x (number) – the rectangle’s pixel x coordinate, 0 is the left edge of the current map. A negative value is where the left map border’s region is

                                                                                                                                                    • +

                                                                                                                                                  • y (number) – the rectangle’s pixel y coordinate, 0 is the top edge of the current map. A negative value is where the top map border’s region is

                                                                                                                                                    • +

                                                                                                                                                  • width (number) – the rectangle’s pixel width

                                                                                                                                                    • +

                                                                                                                                                  • height (number) – the rectangle’s pixel height

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setClippingRect(x, y, width, height)
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Sets the rectangular clipping region for all overlay layers. A clipping region will cause the overlay’s rendering to be contained inside it. In other words, any content from the overlay layer will not be visible outside of the specified rectangle.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • x (number) – the rectangle’s pixel x coordinate, 0 is the left edge of the current map. A negative value is where the left map border’s region is

                                                                                                                                                    • +

                                                                                                                                                  • y (number) – the rectangle’s pixel y coordinate, 0 is the top edge of the current map. A negative value is where the top map border’s region is

                                                                                                                                                    • +

                                                                                                                                                  • width (number) – the rectangle’s pixel width

                                                                                                                                                    • +

                                                                                                                                                  • height (number) – the rectangle’s pixel height

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.clearClippingRect(layer)
                                                                                                                                                  +

                                                                                                                                                  Clears any clipping for the specified overlay layer. See setClippingRect for more info about clipping.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.clearClippingRect()
                                                                                                                                                  +

                                                                                                                                                  Clears any clipping for all overlay layers. See setClippingRect for more info about clipping.

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.getPosition(layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Gets the position of the specified overlay layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Returns {x, y}
                                                                                                                                                  +

                                                                                                                                                  the layer’s pixel coordinates

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setPosition(x, y, layer)
                                                                                                                                                  +

                                                                                                                                                  Sets the position of the specified overlay layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • x (number) – the pixel x coordinate

                                                                                                                                                    • +

                                                                                                                                                  • y (number) – the pixel y coordinate

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.setPosition(x, y)
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Sets the position of all active overlay layers. Layers that have not been used yet will not have their position changed.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • x (number) – the pixel x coordinate

                                                                                                                                                    • +

                                                                                                                                                  • y (number) – the pixel y coordinate

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.move(deltaX, deltaY, layer)
                                                                                                                                                  +

                                                                                                                                                  Moves the specified overlay layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • deltaX (number) – the number of pixels to move horizontally

                                                                                                                                                    • +

                                                                                                                                                  • deltaY (number) – the number of pixels to move vertically

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.move(deltaX, deltaY)
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Moves all active overlay layers. Layers that have not been used yet will not have their position changed.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • deltaX (number) – the number of pixels to move horizontally

                                                                                                                                                    • +

                                                                                                                                                  • deltaY (number) – the number of pixels to move vertically

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.addText(text, x, y, color = "#000000", size = 12, layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Adds a text item to the specified overlay layer. Text can be additionally formatted with a limited set of HTML tags. Note that only text can be displayed, so text decoration like underlines or table borders will not appear.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • text (string) – the text to display

                                                                                                                                                    • +

                                                                                                                                                  • x (number) – the x pixel coordinate of the text (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • y (number) – the y pixel coordinate of the text (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • color (string) – the color of the text. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.

                                                                                                                                                    • +

                                                                                                                                                  • size (number) – the font size of the text. Defaults to 12.

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.addRect(x, y, width, height, borderColor = "#000000", fillColor = "", rounding = 0, layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Adds a rectangle outline item to the specified overlay layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • x (number) – the x pixel coordinate of the rectangle’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • y (number) – the y pixel coordinate of the rectangle’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • width (number) – the pixel width of the rectangle

                                                                                                                                                    • +

                                                                                                                                                  • height (number) – the pixel height of the rectangle

                                                                                                                                                    • +

                                                                                                                                                  • borderColor (string) – the color of the rectangle’s border. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.

                                                                                                                                                    • +

                                                                                                                                                  • fillColor (string) – the color of the area enclosed by the rectangle. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to transparent.

                                                                                                                                                    • +

                                                                                                                                                  • rounding (number) – the percent degree the corners will be rounded. 0 is rectangular, 100 is elliptical. Defaults to 0

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.addPath(coords, borderColor = "#000000", fillColor = "", layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Draws a straight path on the specified layer by connecting the coordinate pairs in coords. The area enclosed by the path can be colored in, and will follow the “odd-even” fill rule.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • coords (array) – array of pixel coordinates to connect to create the path. Each element of the array should be an array containing an x and y pixel coordinate

                                                                                                                                                    • +

                                                                                                                                                  • borderColor (string) – the color of the path. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.

                                                                                                                                                    • +

                                                                                                                                                  • fillColor (string) – the color of the area enclosed by the path. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to transparent.

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.addPath(xCoords, yCoords, borderColor = "#000000", fillColor = "", layer = 0)
                                                                                                                                                  +

                                                                                                                                                  This is an overloaded function. Draws a straight path on the specified layer by connecting the coordinates at (xCoords, yCoords). The area enclosed by the path can be colored in, and will follow the “odd-even” fill rule.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • xCoords (array) – array of x pixel coordinates to connect to create the path

                                                                                                                                                    • +

                                                                                                                                                  • yCoords (array) – array of y pixel coordinates to connect to create the path

                                                                                                                                                    • +

                                                                                                                                                  • borderColor (string) – the color of the path. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.

                                                                                                                                                    • +

                                                                                                                                                  • fillColor (string) – the color of the area enclosed by the path. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to transparent.

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.addImage(x, y, filepath, layer = 0, useCache = true)
                                                                                                                                                  +

                                                                                                                                                  Adds an image item to the specified overlay layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • x (number) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • y (number) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • filepath (string) – the image’s filepath

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +

                                                                                                                                                  • useCache (boolean) – 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.

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.createImage(x, y, filepath, width = -1, height = -1, xOffset = 0, yOffset = 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 overlay.addImage by allowing the new image to be a transformation of the image file.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • x (number) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • y (number) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • filepath (string) – the image’s filepath

                                                                                                                                                    • +

                                                                                                                                                  • width (number) – 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

                                                                                                                                                    • +

                                                                                                                                                  • height (number) – 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

                                                                                                                                                    • +

                                                                                                                                                  • xOffset (number) – the x pixel coordinate on the original image where data should be read from. Defaults to 0

                                                                                                                                                    • +

                                                                                                                                                  • yOffset (number) – the y pixel coordinate on the original image where data should be read from. Defaults to 0

                                                                                                                                                    • +

                                                                                                                                                  • hScale (number) – the horizontal scale for the image. Negative values will be a horizontal flip of the original image. Defaults to 1

                                                                                                                                                    • +

                                                                                                                                                  • vScale (number) – the vertical scale for the image. Negative values will be a vertical flip of the original image. Defaults to 1

                                                                                                                                                    • +

                                                                                                                                                  • paletteId (number) – the id of which currently loaded tileset palette to use for the image. If -1, use the original image’s palette. Defaults to -1

                                                                                                                                                    • +

                                                                                                                                                  • setTransparency (boolean) – whether the color at index 0 should be overwritten with transparent pixels. Defaults to false

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +

                                                                                                                                                  • useCache (boolean) – 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.

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.addTileImage(x, y, tileId, xflip, yflip, palette, setTransparency = false, layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Creates an image of a tile on the specified overlay layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • x (number) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • y (number) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • tileId (number) – tile value for the image

                                                                                                                                                    • +

                                                                                                                                                  • xflip (boolean) – whether the tile image is flipped horizontally

                                                                                                                                                    • +

                                                                                                                                                  • yflip (boolean) – whether the tile image is flipped vertically

                                                                                                                                                    • +

                                                                                                                                                  • palette (number) – palette number for the tile image

                                                                                                                                                    • +

                                                                                                                                                  • setTransparency (boolean) – whether the color at index 0 should be overwritten with transparent pixels. Defaults to false

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.addTileImage(x, y, tile, setTransparency = false, layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Creates an image of a tile on the specified overlay layer. This is an overloaded function that takes a single tile as a JavaScript object instead of each of the tile’s properties individually.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • x (number) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • y (number) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • tile ({tileId,xflip,yflip,palette}) – the tile to create an image of

                                                                                                                                                    • +

                                                                                                                                                  • setTransparency (boolean) – whether the color at index 0 should be overwritten with transparent pixels. Defaults to false

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +overlay.addMetatileImage(x, y, metatileId, setTransparency = false, layer = 0)
                                                                                                                                                  +

                                                                                                                                                  Creates an image of a metatile on the specified overlay layer.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Arguments
                                                                                                                                                  +
                                                                                                                                                    +

                                                                                                                                                  • x (number) – the x pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • y (number) – the y pixel coordinate of the image’s top-left corner (relative to the layer’s position)

                                                                                                                                                    • +

                                                                                                                                                  • metatileId (number) – id of the metatile to create an image of

                                                                                                                                                    • +

                                                                                                                                                  • setTransparency (boolean) – whether the color at index 0 should be overwritten with transparent pixels. Defaults to false

                                                                                                                                                    • +

                                                                                                                                                  • layer (number) – the layer id. Defaults to 0

                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Settings Functions

                                                                                                                                                  The following functions are related to settings.

                                                                                                                                                  +

                                                                                                                                                  All settings functions are callable via the global utility object.

                                                                                                                                                  -
                                                                                                                                                  -map.getGridVisibility()
                                                                                                                                                  +
                                                                                                                                                  +utility.getGridVisibility()

                                                                                                                                                  Gets the visibility of the map grid overlay.

                                                                                                                                                  Returns boolean
                                                                                                                                                  @@ -2592,8 +2734,8 @@
                                                                                                                                                  -
                                                                                                                                                  -map.setGridVisibility(visible)
                                                                                                                                                  +
                                                                                                                                                  +utility.setGridVisibility(visible)

                                                                                                                                                  Sets the visibility of the map grid overlay.

                                                                                                                                                  Arguments
                                                                                                                                                  @@ -2605,8 +2747,8 @@
                                                                                                                                                  -
                                                                                                                                                  -map.getBorderVisibility()
                                                                                                                                                  +
                                                                                                                                                  +utility.getBorderVisibility()

                                                                                                                                                  Gets the visibility of the map’s border.

                                                                                                                                                  Returns boolean
                                                                                                                                                  @@ -2616,8 +2758,8 @@
                                                                                                                                                  -
                                                                                                                                                  -map.setBorderVisibility(visible)
                                                                                                                                                  +
                                                                                                                                                  +utility.setBorderVisibility(visible)

                                                                                                                                                  Sets the visibility of the map’s border.

                                                                                                                                                  Arguments
                                                                                                                                                  @@ -2629,8 +2771,8 @@
                                                                                                                                                  -
                                                                                                                                                  -map.getSmartPathsEnabled()
                                                                                                                                                  +
                                                                                                                                                  +utility.getSmartPathsEnabled()

                                                                                                                                                  Gets the toggle state of smart paths.

                                                                                                                                                  Returns boolean
                                                                                                                                                  @@ -2640,8 +2782,8 @@
                                                                                                                                                  -
                                                                                                                                                  -map.setSmartPathsEnabled(enabled)
                                                                                                                                                  +
                                                                                                                                                  +utility.setSmartPathsEnabled(enabled)

                                                                                                                                                  Sets the toggle state of smart paths.

                                                                                                                                                  Arguments
                                                                                                                                                  @@ -2653,30 +2795,8 @@
                                                                                                                                                  -
                                                                                                                                                  -map.getBaseGameVersion()
                                                                                                                                                  -

                                                                                                                                                  Gets the project’s base game version.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns string
                                                                                                                                                  -

                                                                                                                                                  "pokeruby", "pokefirered", or "pokeemerald"

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getPorymapVersion()
                                                                                                                                                  -

                                                                                                                                                  Gets the current version of Porymap (MAJOR.MINOR.PATCH).

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns {major, minor, patch}
                                                                                                                                                  -

                                                                                                                                                  the version object

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -map.getCustomScripts()
                                                                                                                                                  +
                                                                                                                                                  +utility.getCustomScripts()

                                                                                                                                                  Gets the list of paths to custom scripts.

                                                                                                                                                  Returns array
                                                                                                                                                  @@ -2686,8 +2806,8 @@
                                                                                                                                                  -
                                                                                                                                                  -map.getMainTab()
                                                                                                                                                  +
                                                                                                                                                  +utility.getMainTab()

                                                                                                                                                  Gets the index of the currently selected main tab. Tabs are indexed from left to right, starting at 0 (0: Map, 1: Events, 2: Header, 3: Connections, 4: Wild Pokemon).

                                                                                                                                                  Returns number
                                                                                                                                                  @@ -2697,8 +2817,8 @@
                                                                                                                                                  -
                                                                                                                                                  -map.setMainTab(tab)
                                                                                                                                                  +
                                                                                                                                                  +utility.setMainTab(tab)

                                                                                                                                                  Sets the currently selected main tab. Tabs are indexed from left to right, starting at 0 (0: Map, 1: Events, 2: Header, 3: Connections, 4: Wild Pokemon).

                                                                                                                                                  Arguments
                                                                                                                                                  @@ -2710,9 +2830,9 @@
                                                                                                                                                  -
                                                                                                                                                  -map.getMapViewTab()
                                                                                                                                                  -

                                                                                                                                                  Gets the index of the currently selected map view tab. Tabs are indexed from left to right, starting at 0 (0: Metatiles, 1: Collision).

                                                                                                                                                  +
                                                                                                                                                  +utility.getMapViewTab()
                                                                                                                                                  +

                                                                                                                                                  Gets the index of the currently selected map view tab. Tabs are indexed from left to right, starting at 0 (0: Metatiles, 1: Collision, 2: Prefabs).

                                                                                                                                                  Returns number

                                                                                                                                                  current map view tab index

                                                                                                                                                  @@ -2721,9 +2841,9 @@
                                                                                                                                                  -
                                                                                                                                                  -map.setMapViewTab(tab)
                                                                                                                                                  -

                                                                                                                                                  Sets the currently selected map view tab. Tabs are indexed from left to right, starting at 0 (0: Metatiles, 1: Collision).

                                                                                                                                                  +
                                                                                                                                                  +utility.setMapViewTab(tab)
                                                                                                                                                  +

                                                                                                                                                  Sets the currently selected map view tab. Tabs are indexed from left to right, starting at 0 (0: Metatiles, 1: Collision, 2: Prefabs).

                                                                                                                                                  Arguments
                                                                                                                                                    @@ -2737,9 +2857,10 @@

                                                                                                                                                    Utility Functions

                                                                                                                                                    These are some miscellaneous functions that can be very useful when building custom scripts.

                                                                                                                                                    +

                                                                                                                                                    All utility functions are callable via the global utility object.

                                                                                                                                                    -
                                                                                                                                                    -map.registerAction(functionName, actionName, shortcut = "")
                                                                                                                                                    +
                                                                                                                                                    +utility.registerAction(functionName, actionName, shortcut = "")

                                                                                                                                                    Registers a JavaScript function to an action that can be manually triggered in Porymap’s Tools menu. Optionally, a keyboard shortcut (e.g. "Ctrl+P") can also be specified, assuming it doesn’t collide with any existing shortcuts used by Porymap. The function specified by functionName must have the export keyword.

                                                                                                                                                    Arguments
                                                                                                                                                    @@ -2753,8 +2874,8 @@
                                                                                                                                                    -
                                                                                                                                                    -map.setTimeout(func, delayMs)
                                                                                                                                                    +
                                                                                                                                                    +utility.setTimeout(func, delayMs)

                                                                                                                                                    This behaves essentially the same as JavaScript’s setTimeout() that is used in web browsers or NodeJS. The func argument is a JavaScript function (NOT the name of a function) which will be executed after a delay. This is useful for creating animations or refreshing the overlay at constant intervals.

                                                                                                                                                    Arguments
                                                                                                                                                    @@ -2767,8 +2888,8 @@
                                                                                                                                                    -
                                                                                                                                                    -map.log(message)
                                                                                                                                                    +
                                                                                                                                                    +utility.log(message)

                                                                                                                                                    Logs a message to the Porymap log file with the prefix [INFO]. This is useful for debugging custom scripts.

                                                                                                                                                    Arguments
                                                                                                                                                    @@ -2780,8 +2901,8 @@
                                                                                                                                                    -
                                                                                                                                                    -map.warn(message)
                                                                                                                                                    +
                                                                                                                                                    +utility.warn(message)

                                                                                                                                                    Logs a message to the Porymap log file with the prefix [WARN].

                                                                                                                                                    Arguments
                                                                                                                                                    @@ -2793,8 +2914,8 @@
                                                                                                                                                    -
                                                                                                                                                    -map.error(message)
                                                                                                                                                    +
                                                                                                                                                    +utility.error(message)

                                                                                                                                                    Logs a message to the Porymap log file with the prefix [ERROR].

                                                                                                                                                    Arguments
                                                                                                                                                    @@ -2806,8 +2927,8 @@
                                                                                                                                                    -
                                                                                                                                                    -map.showMessage(text, informativeText, detailedText)
                                                                                                                                                    +
                                                                                                                                                    +utility.showMessage(text, informativeText, detailedText)

                                                                                                                                                    Displays a message box with an “Information” icon and an OK button. Execution stops while the window is open.

                                                                                                                                                    Arguments
                                                                                                                                                    @@ -2821,8 +2942,8 @@
                                                                                                                                                    -
                                                                                                                                                    -map.showWarning(text, informativeText, detailedText)
                                                                                                                                                    +
                                                                                                                                                    +utility.showWarning(text, informativeText, detailedText)

                                                                                                                                                    Displays a message box with a “Warning” icon and an OK button. Execution stops while the window is open.

                                                                                                                                                    Arguments
                                                                                                                                                    @@ -2836,8 +2957,8 @@
                                                                                                                                                    -
                                                                                                                                                    -map.showError(text, informativeText, detailedText)
                                                                                                                                                    +
                                                                                                                                                    +utility.showError(text, informativeText, detailedText)

                                                                                                                                                    Displays a message box with a “Critical” icon and an OK button. Execution stops while the window is open.

                                                                                                                                                    Arguments
                                                                                                                                                    @@ -2851,8 +2972,8 @@
                                                                                                                                                    -
                                                                                                                                                    -map.showQuestion(text, informativeText, detailedText)
                                                                                                                                                    +
                                                                                                                                                    +utility.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.

                                                                                                                                                    Arguments
                                                                                                                                                    @@ -2869,8 +2990,8 @@
                                                                                                                                                    -
                                                                                                                                                    -map.getInputText(title, label, default)
                                                                                                                                                    +
                                                                                                                                                    +utility.getInputText(title, label, default)

                                                                                                                                                    Displays a text input dialog with an OK and a Cancel button. Execution stops while the window is open.

                                                                                                                                                    Arguments
                                                                                                                                                    @@ -2887,8 +3008,8 @@
                                                                                                                                                    -
                                                                                                                                                    -map.getInputNumber(title, label, default, min, max, decimals, step)
                                                                                                                                                    +
                                                                                                                                                    +utility.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.

                                                                                                                                                    Arguments
                                                                                                                                                    @@ -2909,8 +3030,8 @@
                                                                                                                                                    -
                                                                                                                                                    -map.getInputItem(title, label, items, default, editable)
                                                                                                                                                    +
                                                                                                                                                    +utility.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.

                                                                                                                                                    Arguments
                                                                                                                                                    @@ -2928,7 +3049,214 @@
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +utility.getMapNames()
                                                                                                                                                    +

                                                                                                                                                    Gets the list of map names.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Returns array
                                                                                                                                                    +

                                                                                                                                                    the list of map names

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +utility.getTilesetNames()
                                                                                                                                                    +

                                                                                                                                                    Gets the list of tileset names.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Returns array
                                                                                                                                                    +

                                                                                                                                                    the list of tileset names

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +utility.getPrimaryTilesetNames()
                                                                                                                                                    +

                                                                                                                                                    Gets the list of primary tileset names.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Returns array
                                                                                                                                                    +

                                                                                                                                                    the list of primary tileset names

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +utility.getSecondaryTilesetNames()
                                                                                                                                                    +

                                                                                                                                                    Gets the list of secondary tileset names.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Returns array
                                                                                                                                                    +

                                                                                                                                                    the list of secondary tileset names

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +utility.getMetatileBehaviorNames()
                                                                                                                                                    +

                                                                                                                                                    Gets the list of metatile behavior names.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Returns array
                                                                                                                                                    +

                                                                                                                                                    the list of metatile behavior names

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +utility.getSongNames()
                                                                                                                                                    +

                                                                                                                                                    Gets the list of song names.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Returns array
                                                                                                                                                    +

                                                                                                                                                    the list of song names

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +utility.getLocationNames()
                                                                                                                                                    +

                                                                                                                                                    Gets the list of map location names.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Returns array
                                                                                                                                                    +

                                                                                                                                                    the list of map location names

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +utility.getWeatherNames()
                                                                                                                                                    +

                                                                                                                                                    Gets the list of weather names.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Returns array
                                                                                                                                                    +

                                                                                                                                                    the list of weather names

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +utility.getMapTypeNames()
                                                                                                                                                    +

                                                                                                                                                    Gets the list of map type names.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Returns array
                                                                                                                                                    +

                                                                                                                                                    the list of map type names

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +utility.getBattleSceneNames()
                                                                                                                                                    +

                                                                                                                                                    Gets the list of battle scene names.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Returns array
                                                                                                                                                    +

                                                                                                                                                    the list of battle scene names

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +utility.isPrimaryTileset(tilesetName)
                                                                                                                                                    +

                                                                                                                                                    Gets whether the specified tileset is a primary tileset.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Arguments
                                                                                                                                                    +
                                                                                                                                                      +

                                                                                                                                                    • tilesetName (string) – the tileset name

                                                                                                                                                      • +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Returns boolean
                                                                                                                                                    +

                                                                                                                                                    is a primary tileset

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +utility.isSecondaryTileset(tilesetName)
                                                                                                                                                    +

                                                                                                                                                    Gets whether the specified tileset is a secondary tileset.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Arguments
                                                                                                                                                    +
                                                                                                                                                      +

                                                                                                                                                    • tilesetName (string) – the tileset name

                                                                                                                                                      • +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Returns boolean
                                                                                                                                                    +

                                                                                                                                                    is a secondary tileset

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Constants

                                                                                                                                                  +

                                                                                                                                                  Some constant values are provided for convenience. These are read-only properties guaranteed not to change unless a new project is opened or the current one is reloaded.

                                                                                                                                                  +

                                                                                                                                                  All constants are accessible via the global constants object.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +constants.max_primary_tiles
                                                                                                                                                  +

                                                                                                                                                  The maximum number of tiles in a primary tileset.

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +constants.max_secondary_tiles
                                                                                                                                                  +

                                                                                                                                                  The maximum number of tiles in a secondary tileset.

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +constants.max_primary_metatiles
                                                                                                                                                  +

                                                                                                                                                  The maximum number of metatiles in a primary tileset.

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +constants.max_secondary_metatiles
                                                                                                                                                  +

                                                                                                                                                  The maximum number of metatiles in a secondary tileset.

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +constants.layers_per_metatile
                                                                                                                                                  +

                                                                                                                                                  The number of tile layers used in each metatile. This will either be 2 or 3, depending on the config setting enable_triple_layer_metatiles.

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +constants.tiles_per_metatile
                                                                                                                                                  +

                                                                                                                                                  The number of tiles in each metatile. This will either be 8 or 12, depending on the config setting enable_triple_layer_metatiles.

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +constants.base_game_version
                                                                                                                                                  +

                                                                                                                                                  The string value of the config setting base_game_version. This will either be pokeruby, pokefirered, or pokeemerald.

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +constants.version.major
                                                                                                                                                  +

                                                                                                                                                  Porymap’s major version number. For example, for Porymap version 5.0.1 this will be 5.

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +constants.version.minor
                                                                                                                                                  +

                                                                                                                                                  Porymap’s minor version number. For example, for Porymap version 5.0.1 this will be 0.

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +constants.version.patch
                                                                                                                                                  +

                                                                                                                                                  Porymap’s patch version number. For example, for Porymap version 5.0.1 this will be 1.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  diff --git a/docs/manual/settings-and-options.html b/docs/manual/settings-and-options.html index ae8d42dc..9c7cbdfa 100644 --- a/docs/manual/settings-and-options.html +++ b/docs/manual/settings-and-options.html @@ -184,12 +184,13 @@
                                                                                                                                                • Functions
                                                                                                                                                  • +
                                                                                                                                                • Constants
                                                                                                                                              @@ -206,100 +207,101 @@

                                                                                                                                              Reference

                                                                                                                                              • Changelog
                                                                                                                                                  -
                                                                                                                                                • Unreleased
                                                                                                                                                    +
                                                                                                                                                  • Unreleased
                                                                                                                                                    • +
                                                                                                                                                  • 5.0.0 - 2022-10-30
                                                                                                                                                    • -
                                                                                                                                                  • 4.5.0 - 2021-12-26
                                                                                                                                                      -
                                                                                                                                                    • Added
                                                                                                                                                      • -
                                                                                                                                                    • Changed
                                                                                                                                                      • -
                                                                                                                                                    • Fixed
                                                                                                                                                      • +
                                                                                                                                                    • 4.5.0 - 2021-12-26
                                                                                                                                                      • -
                                                                                                                                                    • 4.4.0 - 2020-12-20
                                                                                                                                                        -
                                                                                                                                                      • Added
                                                                                                                                                        • -
                                                                                                                                                      • Changed
                                                                                                                                                        • -
                                                                                                                                                      • Fixed
                                                                                                                                                        • +
                                                                                                                                                      • 4.4.0 - 2020-12-20
                                                                                                                                                        • -
                                                                                                                                                      • 4.3.1 - 2020-07-17
                                                                                                                                                          -
                                                                                                                                                        • Added
                                                                                                                                                          • -
                                                                                                                                                        • Changed
                                                                                                                                                          • -
                                                                                                                                                        • Fixed
                                                                                                                                                          • +
                                                                                                                                                        • 4.3.1 - 2020-07-17
                                                                                                                                                          • -
                                                                                                                                                        • 4.3.0 - 2020-06-27
                                                                                                                                                            -
                                                                                                                                                          • Added
                                                                                                                                                            • -
                                                                                                                                                          • Changed
                                                                                                                                                            • -
                                                                                                                                                          • Fixed
                                                                                                                                                            • +
                                                                                                                                                          • 4.3.0 - 2020-06-27
                                                                                                                                                            • -
                                                                                                                                                          • 4.2.0 - 2020-06-06
                                                                                                                                                              -
                                                                                                                                                            • Added
                                                                                                                                                              • -
                                                                                                                                                            • Changed
                                                                                                                                                              • -
                                                                                                                                                            • Fixed
                                                                                                                                                              • +
                                                                                                                                                            • 4.2.0 - 2020-06-06
                                                                                                                                                              • -
                                                                                                                                                            • 4.1.0 - 2020-05-18
                                                                                                                                                                -
                                                                                                                                                              • Added
                                                                                                                                                                • -
                                                                                                                                                              • Changed
                                                                                                                                                                • -
                                                                                                                                                              • Fixed
                                                                                                                                                                • +
                                                                                                                                                              • 4.1.0 - 2020-05-18
                                                                                                                                                                • -
                                                                                                                                                              • 4.0.0 - 2020-04-28
                                                                                                                                                                  -
                                                                                                                                                                • Breaking Changes
                                                                                                                                                                  • -
                                                                                                                                                                • Added
                                                                                                                                                                  • -
                                                                                                                                                                • Changed
                                                                                                                                                                  • -
                                                                                                                                                                • Fixed
                                                                                                                                                                  • +
                                                                                                                                                                • 4.0.0 - 2020-04-28
                                                                                                                                                                  • -
                                                                                                                                                                • 3.0.1 - 2020-03-04
                                                                                                                                                                    -
                                                                                                                                                                  • Fixed
                                                                                                                                                                    • +
                                                                                                                                                                  • 3.0.1 - 2020-03-04
                                                                                                                                                                    • -
                                                                                                                                                                  • 3.0.0 - 2020-03-04
                                                                                                                                                                      -
                                                                                                                                                                    • Breaking Changes
                                                                                                                                                                      • -
                                                                                                                                                                    • Added
                                                                                                                                                                      • -
                                                                                                                                                                    • Changed
                                                                                                                                                                      • -
                                                                                                                                                                    • Fixed
                                                                                                                                                                      • +
                                                                                                                                                                    • 3.0.0 - 2020-03-04
                                                                                                                                                                      • -
                                                                                                                                                                    • 2.0.0 - 2019-10-16
                                                                                                                                                                        -
                                                                                                                                                                      • Breaking Changes
                                                                                                                                                                        • -
                                                                                                                                                                      • Added
                                                                                                                                                                        • -
                                                                                                                                                                      • Changed
                                                                                                                                                                        • -
                                                                                                                                                                      • Fixed
                                                                                                                                                                        • +
                                                                                                                                                                      • 2.0.0 - 2019-10-16
                                                                                                                                                                        • -
                                                                                                                                                                      • 1.2.2 - 2019-05-16
                                                                                                                                                                          -
                                                                                                                                                                        • Added
                                                                                                                                                                          • -
                                                                                                                                                                        • Changed
                                                                                                                                                                          • -
                                                                                                                                                                        • Fixed
                                                                                                                                                                          • +
                                                                                                                                                                        • 1.2.2 - 2019-05-16
                                                                                                                                                                          • -
                                                                                                                                                                        • 1.2.1 - 2019-02-16
                                                                                                                                                                            -
                                                                                                                                                                          • Added
                                                                                                                                                                            • -
                                                                                                                                                                          • Fixed
                                                                                                                                                                            • +
                                                                                                                                                                          • 1.2.1 - 2019-02-16
                                                                                                                                                                            • -
                                                                                                                                                                          • 1.2.0 - 2019-02-04
                                                                                                                                                                              -
                                                                                                                                                                            • Breaking Changes
                                                                                                                                                                              • -
                                                                                                                                                                            • Added
                                                                                                                                                                              • -
                                                                                                                                                                            • Changed
                                                                                                                                                                              • -
                                                                                                                                                                            • Fixed
                                                                                                                                                                              • +
                                                                                                                                                                            • 1.2.0 - 2019-02-04
                                                                                                                                                                              • -
                                                                                                                                                                            • 1.1.0 - 2018-12-27
                                                                                                                                                                            • Related Projects
                                                                                                                                                                              • @@ -376,7 +378,9 @@ A global settings file is stored in a platform-dependent location for app config (%Appdata%\pret\porymap\porymap.cfg on Windows, ~/Library/Application\ Support/pret/porymap/porymap.cfg on macOS).

                                                                                                                                                                              A config file is also created when opening a project in porymap for the first time. It is stored in your project root as porymap.project.cfg. There are several project-specific settings that are -determined by this file.

                                                                                                                                                                              +determined by this file. You may want to force commit this file so that other users will automatically have access to your project settings.

                                                                                                                                                                              +

                                                                                                                                                                              A second config file is created for user-specific settings. It is stored in +your project root as porymap.user.cfg. You should add this file to your gitignore.

                                                                                                                                                                              @@ -408,7 +412,7 @@ determined by this file.

                                                                                                                                                                              - + @@ -478,111 +482,135 @@ determined by this file.

                                                                                                                                                                              - - - - - - - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + @@ -592,6 +620,24 @@ determined by this file.

                                                                                                                                                                              + + + + + + + + + + + + + + + + + +

                                                                                                                                                                              recent_map

                                                                                                                                                                              global

                                                                                                                                                                              user

                                                                                                                                                                              yes

                                                                                                                                                                              The map that will be opened on launch

                                                                                                                                                                              yes

                                                                                                                                                                              Whether porymap will monitor changes to project files

                                                                                                                                                                              region_map_dimensions

                                                                                                                                                                              32x20

                                                                                                                                                                              global

                                                                                                                                                                              yes

                                                                                                                                                                              The dimensions of the region map tilemap

                                                                                                                                                                              theme

                                                                                                                                                                              theme

                                                                                                                                                                              default

                                                                                                                                                                              global

                                                                                                                                                                              yes

                                                                                                                                                                              The color theme for porymap windows and widgets

                                                                                                                                                                              text_editor_goto_line

                                                                                                                                                                              text_editor_goto_line

                                                                                                                                                                              global

                                                                                                                                                                              yes

                                                                                                                                                                              The command that will be executed when clicking the button next the Script combo-box.

                                                                                                                                                                              text_editor_open_directory

                                                                                                                                                                              text_editor_open_directory

                                                                                                                                                                              global

                                                                                                                                                                              yes

                                                                                                                                                                              The command that will be executed when clicking Open Project in Text Editor.

                                                                                                                                                                              base_game_version

                                                                                                                                                                              base_game_version

                                                                                                                                                                              project

                                                                                                                                                                              no

                                                                                                                                                                              The base pret repo for this project

                                                                                                                                                                              use_encounter_json

                                                                                                                                                                              use_encounter_json

                                                                                                                                                                              1

                                                                                                                                                                              project

                                                                                                                                                                              user

                                                                                                                                                                              yes

                                                                                                                                                                              Enables wild encounter table editing

                                                                                                                                                                              use_poryscript

                                                                                                                                                                              use_poryscript

                                                                                                                                                                              0

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              Whether to open .pory files for scripts

                                                                                                                                                                              use_custom_border_size

                                                                                                                                                                              use_custom_border_size

                                                                                                                                                                              0

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              Whether to allow variable border sizes

                                                                                                                                                                              enable_event_weather_trigger

                                                                                                                                                                              enable_event_weather_trigger

                                                                                                                                                                              1 if not pokefirered

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              Allows adding Weather Trigger events

                                                                                                                                                                              enable_event_secret_base

                                                                                                                                                                              enable_event_secret_base

                                                                                                                                                                              1 if not pokefirered

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              Allows adding Secret Base events

                                                                                                                                                                              enable_event_clone_object

                                                                                                                                                                              enable_event_clone_object

                                                                                                                                                                              1 if pokefirered

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              Allows adding Clone Object events

                                                                                                                                                                              enable_hidden_item_quantity

                                                                                                                                                                              enable_hidden_item_quantity

                                                                                                                                                                              1 if pokefirered

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              Adds Quantity to Hidden Item events

                                                                                                                                                                              enable_hidden_item_requires_itemfinder

                                                                                                                                                                              enable_hidden_item_requires_itemfinder

                                                                                                                                                                              1 if pokefirered

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              Adds Requires Itemfinder to Hidden Item events

                                                                                                                                                                              enable_heal_location_respawn_data

                                                                                                                                                                              enable_heal_location_respawn_data

                                                                                                                                                                              1 if pokefirered

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              Adds Respawn Map and Respawn NPC to Heal Location events

                                                                                                                                                                              enable_floor_number

                                                                                                                                                                              enable_floor_number

                                                                                                                                                                              1 if pokefirered

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              Adds Floor Number to map headers

                                                                                                                                                                              create_map_text_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

                                                                                                                                                                              enable_triple_layer_metatiles

                                                                                                                                                                              0

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              Enables triple-layer metatiles (See https://github.com/pret/pokeemerald/wiki/Triple-layer-metatiles)

                                                                                                                                                                              new_map_metatile

                                                                                                                                                                              1

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              The metatile id that will be used to fill new maps

                                                                                                                                                                              new_map_elevation

                                                                                                                                                                              3

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              The elevation that will be used to fill new maps

                                                                                                                                                                              new_map_border_metatiles

                                                                                                                                                                              468,469,476,477 or 20,21,28,29

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              The list of metatile ids that will be used to fill the 2x2 border of new maps

                                                                                                                                                                              default_primary_tileset

                                                                                                                                                                              gTileset_General

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              The label of the default primary tileset

                                                                                                                                                                              default_secondary_tileset

                                                                                                                                                                              gTileset_Petalburg or gTileset_PalletTown

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              The label of the default secondary tileset

                                                                                                                                                                              custom_scripts

                                                                                                                                                                              project

                                                                                                                                                                              user

                                                                                                                                                                              yes

                                                                                                                                                                              A list of script files to load into the scripting engine

                                                                                                                                                                              yes

                                                                                                                                                                              The filepath containing prefab JSON data

                                                                                                                                                                              prefabs_import_prompted

                                                                                                                                                                              0

                                                                                                                                                                              project

                                                                                                                                                                              no

                                                                                                                                                                              Keeps track of whether or not the project was prompted for importing default prefabs

                                                                                                                                                                              tilesets_have_callback

                                                                                                                                                                              1

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              Whether new tileset headers should have the callback field

                                                                                                                                                                              tilesets_have_is_compressed

                                                                                                                                                                              1

                                                                                                                                                                              project

                                                                                                                                                                              yes

                                                                                                                                                                              Whether new tileset headers should have the isCompressed field

                                                                                                                                                                              Some of these settings can be toggled manually in porymap via the Options menu.

                                                                                                                                                                              diff --git a/docs/objects.inv b/docs/objects.inv index 950099c63ef7f4e57553b85f059f23312e29a71e..08474987a4e0e8f90a660b3f59fb07b6f3ab9b8f 100644 GIT binary patch delta 1813 zcmV+w2kQ9F4fhU^cYohg+c*%%-}6^^=I+&$_IlS|-+)5POrg1iEA11bSc@Z&EuU5f z(!c&B|B4-)FqJlM#F9ReR=d)EWs|5J4a*H4EEvK~$}+fl0F6TB(H(wZ#%Qr94MeY_ zjO8VhuQ1V~Fd|RmgcWQdq%Z>TU}-Y>+wW04NjjorD@(d5K!4w4V3-jSf|(h6x+%2C zm|k^IB&E_35$tbHKhiaqhFMW)m#J|fJKQ^^>1ZM+q!r90OHW$Hii1U&+=Dq2QaZ?O znJ30YjVI$wt85MuYKS*5QCTL8fBO{7k(BE3Slru+;ha;nbx26FGS5Rn$9AbD%oE5V zj3ZTYA4X7`gMa=gGRU1XA_43(h;(TPKo`v}aLx%}*Mgg65a&cmDKIE1EQQF_rxG5R z2_4LtR7zi#*#dMBhhWLSs3d$ot;Za-J1LUjj$z3jgwiCi(>zgSZa`nH3Lqf{#z%|! z!WJNjNH*d6TChZz6(P`tF&&P~{8ykg6FD8PNqk5^VSfQ&w}xq*j#jKSnixwm(s`SX zQjc{L96s9N>Cr&jy2zaCi;~tO{gPp;DrO<$9l3`fhu<1UeFp34=!lba` z7Bub!N;2T3dTdjXOO^#1Rt4$=H^HfR0vTqo;G^jpm{|rMzJUpN#!``liQEoBq;WNH z%>vvFiGMUMl4)F|(zr;ZanW1j3Vyi3K%!+wO4W>1su?L&GZLw0BvH*sqneRKH6xK~ z#&Fe)6sj3%RWnkmW+Ye5NTZsOOf@65YDQYsjHId=iB&U(s%F7okE76s^=8eYQg}$N z@Ni!W59t*i?oHt#nZiR#g@=1kc(^}>hx<@?xPM25hm;BrLlqu|N;4#oW*98Za4Bv* zeO~2NYJRe0c?vv;@mW29rUOY}Isi0C#Y0C`!DfKsXDH;GO~tFy)s;$9>5sc`XE$2} z&g_B}UkfV`LjZwxv4pwv-yp&_yD5cRW2)7i6{jasVK5}jtj)IjZ^4VJTk$}E|HX@<2)A|4k zMtu(^{0Ji~1^0@zw>?H?|L_WocRh%9Yk%#BdELXf+q%$reLLg@hne8-heYo{6a3wf zkGWq&Jl!;1pB?D%=eQ8LSaf;i!#w5HtfE-bKf06T?vteba3ePMgx@`ChwSQigI<67;c^6Y|N3+*(tlDz&m?zf zi#-f-(y*LW>;Vv6+iE@2oC%QJ_ULYm93_WGH^}i>Jge1p(iBv7w>tq&`V+3dEq=)? zRjn3yS{FE0R2>Twc!1o**1?LGQB~cJWj(uyPOC?g6s(hTcp4(wr&WvS-2FLOSK}&i zm3lR%O0R4`(MOe(ndMfA>wjdMk@}FGh8!{DPWKrB@9?vMO*@a<(nX%vAAh~vM^|&K zldf>Gb(LP|ptqC*cC(%%EtbICha9`Hb*1On&(-r$?%IpDW7j@B;=#M)bq9GYvOE4T zp1WQ|ZnWZMy$e4__lsMvUq5Lfxs?Pd+k#jZ)_}|IciX(E->}5DTYoG!C~qRGeq^_$ zp2ePR$0MxqEjzlhJKn4+s=cNvn(RE2M&LURuV~(uMJK(ot_v`(3}a>w9aU@#sj+Iq zt!CcT=)g;*O;V1=PgmBAu>IM#HFci7-I&7)YfH8XdS^y!Z0k05zQ2ByR?AU0u1--` zL$a04()?Ios+TYo?Y>v~LbK`0ES)>`TWh!lZ6g$3CDofv zCqjB=9Vu=${Pt&$ph3EKiE$GhI1bvZRr6-`(>9E7qBDqXqhB-Uc+hA&T^$>xvJEE)Oef1>`}$eqs&)C)rdE@!p|jcZ*5I*yKMNm&+YSvf;`WU-HXQ$d6|D+> DlnQ1> delta 1642 zcmV-w29^2u4$cjbcYjTD+cpq}@A?&-X|GJ0_LiIN$R9JYqe^Pr9wBl~A_f5#3rbdh zeF1)nvMG6@T^&4Q5x@grvDgJ(QH3Z!h%~*HN^w^HZf0CykCiMTO9nP#-a| zvUE~saUx2wl1e%W_#t0NGlM3i0@_%HO@InNfJ`b6GYB{Sa zc?K8O=k&4c7}wSm3sBHNP6j3lg#ES#tHhRvf&`2y3Q1V0#DZ{ChXZSkJ-vAb?m{WE zxs=boBAqiuUx$S>ue7FuE(OAkDBwF-B>7#cGRZTIU~CHZi!4BgSs?@L z7G#z?22dYHQ-227cZssDvSolh%GBi~&XrM0lKtqaLg!;)U75CYOdc>*uojLwt!rhB zeW;2R(4x_el_}G@GdT5~E-QEEprBJ2Y*TY+rvp#-z9A5n3tKA zg|ORj?m_>cjX}tZU2-57kQkkwVXUvg45Mv_cHx|rtAENd;VvN;Ye_t_bg-#TOr;&z z<+cPCA~A7wn6F|5iixxZ`>hlSH5~2(LrUbsv6+AA&$A)4u<`sK8;G_6d;-|B8JTvD zsP_iTGVk+5y%8|WXluxw?gmN1wYN-;{oA5u1|>Otw=AZER!jSv1M&|EGBbAT|K+&v z?Qa7{)PGDUa1Qv1GYe~fp5h1N8IT-lf#M!(0CRo z%YbvU=`Jx3q97X9`=%eA%WK#A`7L~}A4J7h~8f6H+R)|a{Gt9i1f%Kts{%Hj!e=z z@=5DRm)4O(hDHV%8hK=B;I$k~K!m zZoei98ms8h3w9COOs{lbX=xH?LE_Ass>BFg`dQTyMBIZQm47v6 zBh{cqPr69c5S$+TA){ASqMI5wS&8I1kaZf%@OFRf#A>vU@HK(au@6>p=+4-Ve%TYE z=Jx@987E06ZN|>0-s7VV$i99*=$$wkk~eyyev(;bVPKLU=!;J<$W_Y)di2!> zrn#1&Qr~0v%|oDQ*n~lj&*Dw3zJHUpptigBaGVS$+`Llso>}Tz9dOzd1XfhL*96v} zUF>s5`97+y+p~PaDx+!rXp(`?T`9cmBf6(`i|8)=JK0rBO%f^%YP7GjL|;r&6`ot4 zMJI=hG=v;A`ohVnLEy0YkMP=D5U;jg{E3}fMwjwugqsj+JNp=Qz6=)t+ME~!TMPhZxK zu>07xbxpoLY|Q-%J4<%*NN+}OZ0|OHzCWKz>*Z(~*I6{w@K+pv`#p{IwQk#>Oga+e z%Wd2hG&8#Q?yjH>_k+@Rn$5N@5AHNsb&mcHQx{WU4c_uDtm oT32n#XZ~n4IkFunctions +
                                                                                                                                                                            • Constants
                                                                                                                                                                          @@ -206,100 +207,101 @@

                                                                                                                                                                          Reference

                                                                                                                                                                          • Changelog
                                                                                                                                                                              -
                                                                                                                                                                            • Unreleased
                                                                                                                                                                                +
                                                                                                                                                                              • Unreleased
                                                                                                                                                                                • +
                                                                                                                                                                              • 5.0.0 - 2022-10-30
                                                                                                                                                                                • -
                                                                                                                                                                              • 4.5.0 - 2021-12-26
                                                                                                                                                                                  -
                                                                                                                                                                                • Added
                                                                                                                                                                                  • -
                                                                                                                                                                                • Changed
                                                                                                                                                                                  • -
                                                                                                                                                                                • Fixed
                                                                                                                                                                                  • +
                                                                                                                                                                                • 4.5.0 - 2021-12-26
                                                                                                                                                                                  • -
                                                                                                                                                                                • 4.4.0 - 2020-12-20
                                                                                                                                                                                    -
                                                                                                                                                                                  • Added
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Changed
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Fixed
                                                                                                                                                                                    • +
                                                                                                                                                                                  • 4.4.0 - 2020-12-20
                                                                                                                                                                                    • -
                                                                                                                                                                                  • 4.3.1 - 2020-07-17
                                                                                                                                                                                      -
                                                                                                                                                                                    • Added
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Changed
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Fixed
                                                                                                                                                                                      • +
                                                                                                                                                                                    • 4.3.1 - 2020-07-17
                                                                                                                                                                                      • -
                                                                                                                                                                                    • 4.3.0 - 2020-06-27
                                                                                                                                                                                        -
                                                                                                                                                                                      • Added
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Changed
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Fixed
                                                                                                                                                                                        • +
                                                                                                                                                                                      • 4.3.0 - 2020-06-27
                                                                                                                                                                                        • -
                                                                                                                                                                                      • 4.2.0 - 2020-06-06
                                                                                                                                                                                          -
                                                                                                                                                                                        • Added
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Changed
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Fixed
                                                                                                                                                                                          • +
                                                                                                                                                                                        • 4.2.0 - 2020-06-06
                                                                                                                                                                                          • -
                                                                                                                                                                                        • 4.1.0 - 2020-05-18
                                                                                                                                                                                            -
                                                                                                                                                                                          • Added
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Changed
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Fixed
                                                                                                                                                                                            • +
                                                                                                                                                                                          • 4.1.0 - 2020-05-18
                                                                                                                                                                                            • -
                                                                                                                                                                                          • 4.0.0 - 2020-04-28
                                                                                                                                                                                              -
                                                                                                                                                                                            • Breaking Changes
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Added
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Changed
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Fixed
                                                                                                                                                                                              • +
                                                                                                                                                                                            • 4.0.0 - 2020-04-28
                                                                                                                                                                                              • -
                                                                                                                                                                                            • 3.0.1 - 2020-03-04
                                                                                                                                                                                                -
                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                • +
                                                                                                                                                                                              • 3.0.1 - 2020-03-04
                                                                                                                                                                                                • -
                                                                                                                                                                                              • 3.0.0 - 2020-03-04
                                                                                                                                                                                                  -
                                                                                                                                                                                                • Breaking Changes
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Added
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Changed
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Fixed
                                                                                                                                                                                                  • +
                                                                                                                                                                                                • 3.0.0 - 2020-03-04
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • 2.0.0 - 2019-10-16
                                                                                                                                                                                                    -
                                                                                                                                                                                                  • Breaking Changes
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  • Added
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                    • +
                                                                                                                                                                                                  • 2.0.0 - 2019-10-16
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  • 1.2.2 - 2019-05-16
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Added
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Changed
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Fixed
                                                                                                                                                                                                      • +
                                                                                                                                                                                                    • 1.2.2 - 2019-05-16
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • 1.2.1 - 2019-02-16
                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Added
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                        • +
                                                                                                                                                                                                      • 1.2.1 - 2019-02-16
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      • 1.2.0 - 2019-02-04
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Breaking Changes
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Added
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Changed
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Fixed
                                                                                                                                                                                                          • +
                                                                                                                                                                                                        • 1.2.0 - 2019-02-04
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • 1.1.0 - 2018-12-27
                                                                                                                                                                                                        • Related Projects
                                                                                                                                                                                                          • @@ -374,58 +376,92 @@

                                                                                                                                                                                                          All notable changes to this project will be documented in this file.

                                                                                                                                                                                                          The format is based on Keep a Changelog, and this project somewhat adheres to Semantic Versioning. The MAJOR version number is bumped when there are breaking changes in the pret projects.

                                                                                                                                                                                                          -

                                                                                                                                                                                                          The “Breaking Changes” listed below are changes that have been made in the decompilation projects (e.g. pokeemerald), which porymap requires in order to work properly. If porymap is used on a project that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.

                                                                                                                                                                                                          +

                                                                                                                                                                                                          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. It also includes changes to the scripting API that may change the behavior of existing porymap scripts. If porymap is used with a project or API script that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.

                                                                                                                                                                                                          -

                                                                                                                                                                                                          Unreleased

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Unreleased

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Nothing, yet.

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +

                                                                                                                                                                                                          5.0.0 - 2022-10-30

                                                                                                                                                                                                          Breaking Changes

                                                                                                                                                                                                          • Proper support for pokefirered’s clone objects was added, which requires the changes made in pokefirered/#484.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Warp IDs are now treated as strings, which requires the change to mapjson made in pokeemerald/#1755. Additionally MAP_NONE was renamed to MAP_DYNAMIC. Both changes also apply to pokefirered and pokeruby.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Many API functions which were previously accessible via the map object are now accessible via one of the new objects overlay, utility, or constants. Some functions were renamed accordingly. See porymap/#460 for a full list of API function name changes.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Arguments for the API function createImage have changed: xflip and yflip have been replaced with hScale and vScale, and offset has been replaced with xOffset and yOffset.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • The API function addFilledRect has been removed; it’s been replaced by new arguments in addRect: color has been replaced with borderColor and fillColor, and a new rounding argument allows ellipses to be drawn.

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

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Add Cut/Copy/Paste for metatiles in the Tileset Editor.

                                                                                                                                                                                                          • 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 ability to export an image of the primary or secondary tileset’s metatiles.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Add new config options for customizing how new maps are filled, setting default tilesets, and whether the most recent project should be opened on launch.

                                                                                                                                                                                                          • Add color picker to palette editor for taking colors from the screen.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Add new features to the scripting API, including the ability to display messages and user input windows, set the overlay’s opacity, rotation, scale, and clipping, interact with map header properties and the map border, read tile pixel data, and more.

                                                                                                                                                                                                          Changed

                                                                                                                                                                                                          • Overhauled the region map editor, adding support for tilemaps, and significant customization. Also now supports pokefirered.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Previous settings will be remembered in the New Map Options window.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • The Custom Attributes table for map headers and events now supports types other than strings.

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

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Unused metatile attribute bits 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.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Tileset data in headers, graphics, and metatiles can now be parsed if written in C.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • The amount of time it takes to render the event panel has been reduced, which is most noticeable when selecting multiple events at once.

                                                                                                                                                                                                          • The selection is no longer reset when pasting events. The newly pasted events are selected instead.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • The currently selected event for each event group will persist between tabs.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • An object event’s sprite will now render if a number is specified instead of a graphics constant.

                                                                                                                                                                                                          • Palette editor ui is updated a bit to allow hex and rgb value input.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Heal location constants will no longer be deleted if they’re not used in the data tables.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • The heal location prefixes SPAWN_ and HEAL_LOCATION_ may now be used interchangeably.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • The number and order of entries in the heal location data tables can now be changed arbitrarily, and independently of each other.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • The metatile behavior is now displayed in the bottom bar mouseover text.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Number values are now allowed in the Tileset Editor’s Metatile Behavior field.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Removed some unnecessary error logs from the scripting API and added new useful ones.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • If any JSON data is the incorrect type Porymap will now attempt to convert it.

                                                                                                                                                                                                          Fixed

                                                                                                                                                                                                            +

                                                                                                                                                                                                          • Fix events losing their assigned script when the script autocomplete is used.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Fix the unsaved changes indicator not disappearing when saving changes to events.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Fix copy and paste for events not including their custom attributes.

                                                                                                                                                                                                          • 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 tree view arrows not displaying for custom themes.

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

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Fix drawing large amounts of text with the scripting API causing a significant drop in performance.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Silence unnecessary error logging when parsing C defines Porymap doesn’t use.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Fix some windows like the Tileset Editor not raising to the front when reactivated.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Fix incorrect limits on Floor Number and Border Width/Height in the New Map Options window.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Fix Border Width/Height being set to 0 when creating a new map from an existing layout.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Fix certain UI elements not highlighting red on some platforms.

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Fix Open Config Folder not responding

                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • Properly update the minimum offset for a connection when the map is changed.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          4.5.0 - 2021-12-26

                                                                                                                                                                                                          -

                                                                                                                                                                                                          Added

                                                                                                                                                                                                          +

                                                                                                                                                                                                          4.5.0 - 2021-12-26

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Added

                                                                                                                                                                                                          • WSL project paths are now supported. (For example, \wsl$\Ubuntu-20.04\home\huderlem\pokeemerald)

                                                                                                                                                                                                          • Add ability to export map timelapse animated GIFs with File -> Export Map Timelapse Image....

                                                                                                                                                                                                            • @@ -437,8 +473,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                            Changed

                                                                                                                                                                                                            +
                                                                                                                                                                                                            +

                                                                                                                                                                                                            Changed

                                                                                                                                                                                                            • New events will be placed in the center of the current view of the map.

                                                                                                                                                                                                            • Scripting API errors are more detailed and logged in more situations.

                                                                                                                                                                                                              • @@ -447,8 +483,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                              Fixed

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Fixed

                                                                                                                                                                                                              • Fix % operator in C defines not being evaluated

                                                                                                                                                                                                              • Fix tileset palette editor crash that could occur when switching maps or tilesets with it open.

                                                                                                                                                                                                                • @@ -458,10 +494,10 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                4.4.0 - 2020-12-20

                                                                                                                                                                                                                -

                                                                                                                                                                                                                Added

                                                                                                                                                                                                                +

                                                                                                                                                                                                                4.4.0 - 2020-12-20

                                                                                                                                                                                                                +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Added

                                                                                                                                                                                                                -
                                                                                                                                                                                                                -

                                                                                                                                                                                                                Changed

                                                                                                                                                                                                                +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Changed

                                                                                                                                                                                                                • Holding shift now toggles “Smart Path” drawing; when the “Smart Paths” checkbox is checked, holding shift will temporarily disable it.

                                                                                                                                                                                                                -
                                                                                                                                                                                                                -

                                                                                                                                                                                                                Fixed

                                                                                                                                                                                                                +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Fixed

                                                                                                                                                                                                                • Fix a bug with the current metatile selection zoom.

                                                                                                                                                                                                                • Fix bug preventing the status bar from updating the current position while dragging events.

                                                                                                                                                                                                                  • @@ -495,26 +531,26 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                  4.3.1 - 2020-07-17

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Added

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  4.3.1 - 2020-07-17

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Added

                                                                                                                                                                                                                  • Add keyboard shortcut Ctrl + D for duplicating map events.

                                                                                                                                                                                                                  • Add keyboard shortcut Ctrl + Shift + Z for “redo” in the tileset editor.

                                                                                                                                                                                                                  • Add scripting api to reorder metatile layers and draw them with opacity.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Changed

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Changed

                                                                                                                                                                                                                  • The tileset editor now syncs its metatile selection with the map’s metatile selector.

                                                                                                                                                                                                                  • The number of object events per map is now limited to OBJECT_EVENT_TEMPLATES_COUNT

                                                                                                                                                                                                                  • The tileset editor can now flip selections that were taken from an existing metatile.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Fixed

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Fixed

                                                                                                                                                                                                                  • Fix bug where editing a metatile layer would have no effect.

                                                                                                                                                                                                                  • Fix a crash that occured when creating a new tileset using triple layer mode.

                                                                                                                                                                                                                    • @@ -525,22 +561,22 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                    4.3.0 - 2020-06-27

                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Added

                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    4.3.0 - 2020-06-27

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Added

                                                                                                                                                                                                                    • Add triple-layer metatiles support.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Changed

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Changed

                                                                                                                                                                                                                    • The “Open Scripts” button will fall back to scripts.inc if scripts.pory doesn’t exist.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Fixed

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Fixed

                                                                                                                                                                                                                    • Fix bug where exported tileset images could be horizontally or vertically flipped.

                                                                                                                                                                                                                    • Fix bug where the map list wasn’t filtered properly after switching filter types.

                                                                                                                                                                                                                      • @@ -548,47 +584,47 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                      4.2.0 - 2020-06-06

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Added

                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      4.2.0 - 2020-06-06

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Added

                                                                                                                                                                                                                      • Add more project-specific configs to better support porting features from different projects.

                                                                                                                                                                                                                      • Add metatile label names to the status bar when hovering over metatiles in the map editor tab.

                                                                                                                                                                                                                      • Add mouse coordinates to the status bar when hovering in the events tab.

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Changed

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Changed

                                                                                                                                                                                                                      • metatile_labels.h is now watched for changes.

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Fixed

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Fixed

                                                                                                                                                                                                                      • Reduce time it takes to load maps and save in the tileset editor.

                                                                                                                                                                                                                      • Fix crash that could occur when parsing unknown symbols when evaluating define expressions.

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      4.1.0 - 2020-05-18

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Added

                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      4.1.0 - 2020-05-18

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Added

                                                                                                                                                                                                                      • Add scripting capabilities, which allows the user to add custom behavior to Porymap using JavaScript scripts.

                                                                                                                                                                                                                      • Add ability to import FRLG tileset .bvd files from Advance Map 1.92.

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Changed

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Changed

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

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Fixed

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Fixed

                                                                                                                                                                                                                      • Disallow drawing new heal locations in the events tab.

                                                                                                                                                                                                                      • Fix issue where the metatile selection window was not resizable.

                                                                                                                                                                                                                        • @@ -599,16 +635,16 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                        4.0.0 - 2020-04-28

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Breaking Changes

                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        4.0.0 - 2020-04-28

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Breaking Changes

                                                                                                                                                                                                                        • If you are using pokeemerald or pokeruby, there were changes made in pokeemerald/#1010 and pokeruby/#776 that you will need to integrate in order to use this version of porymap.

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Added

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Added

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Changed

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Changed

                                                                                                                                                                                                                        • Porymap now saves map and encounter json data in an order consistent with the upstream repos. This will provide more comprehensible diffs when files are saved.

                                                                                                                                                                                                                        • Update Porymap icon.

                                                                                                                                                                                                                          • @@ -628,8 +664,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                          Fixed

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Fixed

                                                                                                                                                                                                                          • Fix bug where pressing TAB key did not navigate through widgets in the wild encounter tables.

                                                                                                                                                                                                                          • Fix bug that allowed selecting an invalid metatile in the metatile selector.

                                                                                                                                                                                                                            • @@ -638,19 +674,19 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                            3.0.1 - 2020-03-04

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Fixed

                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            3.0.1 - 2020-03-04

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Fixed

                                                                                                                                                                                                                            • Fix bug on Mac where tileset images were corrupted when saving.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            3.0.0 - 2020-03-04

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Breaking Changes

                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            3.0.0 - 2020-03-04

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Breaking Changes

                                                                                                                                                                                                                            • pokeemerald and pokeruby both underwent a naming consistency update with respect to “object events”. As such, these naming changes break old versions of Porymap.

                                                                                                                                                                                                                                @@ -660,22 +696,22 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                Added

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Added

                                                                                                                                                                                                                                • Add optional support for Poryscript script files via the use_poryscript config option.

                                                                                                                                                                                                                                • Selecting a group of metatiles from the map area now also copies the collision properties, too.

                                                                                                                                                                                                                                • Add keyboard shortcut Ctrl + G for toggling the map grid.

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Changed

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Changed

                                                                                                                                                                                                                                • Draw map connections with the current map’s tilesets to more accurately mimic their appearance in-game.

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Fixed

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Fixed

                                                                                                                                                                                                                                • Fix index-out-of-bounds crash when deleting the last event in an event type group.

                                                                                                                                                                                                                                • Fix bug where exporting tileset images could add an extra row of junk at the end.

                                                                                                                                                                                                                                  • @@ -685,17 +721,17 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                  2.0.0 - 2019-10-16

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Breaking Changes

                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  2.0.0 - 2019-10-16

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Breaking Changes

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Added

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Added

                                                                                                                                                                                                                                  • Add wild encounter table editor.

                                                                                                                                                                                                                                  • Add dark themes.

                                                                                                                                                                                                                                    • @@ -703,16 +739,16 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                    Changed

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Changed

                                                                                                                                                                                                                                    • Exporting map images is now more configurable. Events, connections, collision, etc. can be toggled on and off before exporting the image.

                                                                                                                                                                                                                                    • The entire Tileset Editor selection is now conveniently flipped when selecting x-flip or y-flip.

                                                                                                                                                                                                                                    • Autocomplete for porymap’s comboboxes no longer require typing the full string prefix.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Fixed

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Fixed

                                                                                                                                                                                                                                    • Fix bug where map group names were hardcoded when creating a new map.

                                                                                                                                                                                                                                    • Fix bug in Tileset Editor where multi-tile selections weren’t properly painted when clicking on the bottom row of the metatile layers.

                                                                                                                                                                                                                                      • @@ -723,18 +759,18 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                      1.2.2 - 2019-05-16

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Added

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      1.2.2 - 2019-05-16

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Added

                                                                                                                                                                                                                                      • Add region map editor

                                                                                                                                                                                                                                      • Add ability to add new tilesets

                                                                                                                                                                                                                                      • Add official Porymap documentation website: https://huderlem.github.io/porymap/

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Changed

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Changed

                                                                                                                                                                                                                                      • Event sprites now display as facing the direction of their movement type.

                                                                                                                                                                                                                                      • Default values for newly-created events now use valid values from the project, rather than hardcoded values.

                                                                                                                                                                                                                                        • @@ -744,8 +780,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                        Fixed

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Fixed

                                                                                                                                                                                                                                        • Fix bug in zoomed metatile selector where a large selection rectangle was being rendered.

                                                                                                                                                                                                                                        • Fix bug where edited map icons were not rendered properly.

                                                                                                                                                                                                                                          • @@ -754,32 +790,32 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                          1.2.1 - 2019-02-16

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Added

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          1.2.1 - 2019-02-16

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Added

                                                                                                                                                                                                                                          • Add ability to zoom in and out the map metatile selector via a slider at the bottom of the metatile selector window.

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Fixed

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Fixed

                                                                                                                                                                                                                                          • Fix crash when creating a new map from a layout that has no pre-existing maps that use it.

                                                                                                                                                                                                                                          • Fix bug where var_value, trainer_type and trainer_sight_or_berry_tree_id JSON fields were being interpreted as integers.

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          1.2.0 - 2019-02-04

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Breaking Changes

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          1.2.0 - 2019-02-04

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Breaking Changes

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Added

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Added

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

                                                                                                                                                                                                                                          • Add ability to import tileset palettes (JASC, .pal, .tpl, .gpl, .act).

                                                                                                                                                                                                                                            • @@ -792,8 +828,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                            Changed

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Changed

                                                                                                                                                                                                                                            • Collapse the map list by default.

                                                                                                                                                                                                                                            • Collision view now has a transparency slider to help make it easier to view the underlying metatiles.

                                                                                                                                                                                                                                              • @@ -807,8 +843,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                              Fixed

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Fixed

                                                                                                                                                                                                                                              • Fix bug where smart paths could be auto-enabled, despite the checkbox being disabled.

                                                                                                                                                                                                                                              • Fix crash that could occur when changing the palette id in the tileset palette editor.

                                                                                                                                                                                                                                                • @@ -817,32 +853,32 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                1.1.0 - 2018-12-27

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Breaking Changes

                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                1.1.0 - 2018-12-27

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Breaking Changes

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Added

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Added

                                                                                                                                                                                                                                                • Add porymap.project.cfg config file to project repos, in order to house project-specific settings, such as base_game_version=pokeemerald.

                                                                                                                                                                                                                                                • Write all logs to porymap.log file, so users can view any errors that porymap hits.

                                                                                                                                                                                                                                                • Changelog

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Changed

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Changed

                                                                                                                                                                                                                                                • Add porymap.cfg base config file, rather than using built-in system settings (e.g. registry on Windows).

                                                                                                                                                                                                                                                • Properly read/write map headers for pokeemerald.

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

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Fixed

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Fixed

                                                                                                                                                                                                                                                • Creating new hidden-item events now uses a valid default flag value.

                                                                                                                                                                                                                                                • Fix bug where tilesets were sometimes not displaying their bottom row of metatiles.

                                                                                                                                                                                                                                                  • @@ -855,8 +891,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                  1.0.0 - 2018-10-26

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  1.0.0 - 2018-10-26

                                                                                                                                                                                                                                                  This was the initial release.

                                                                                                                                                                                                                                                diff --git a/docs/search.html b/docs/search.html index 59fb41a8..de7acf4a 100644 --- a/docs/search.html +++ b/docs/search.html @@ -183,12 +183,13 @@
                                                                                                                                                                                                                                              • Functions
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                              • Constants
                                                                                                                                                                                                                                            @@ -205,100 +206,101 @@

                                                                                                                                                                                                                                            Reference

                                                                                                                                                                                                                                            • Changelog
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                              • Unreleased
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                • Unreleased
                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                • 5.0.0 - 2022-10-30
                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                • 4.5.0 - 2021-12-26
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                  • 4.5.0 - 2021-12-26
                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                  • 4.4.0 - 2020-12-20
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                    • Added
                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                    • Changed
                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                    • Fixed
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    • 4.4.0 - 2020-12-20
                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                    • 4.3.1 - 2020-07-17
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                      • Added
                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                      • Changed
                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                      • 4.3.1 - 2020-07-17
                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                      • 4.3.0 - 2020-06-27
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                        • Added
                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                        • Changed
                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                        • Fixed
                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                        • 4.3.0 - 2020-06-27
                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                        • 4.2.0 - 2020-06-06
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                          • 4.2.0 - 2020-06-06
                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                          • 4.1.0 - 2020-05-18
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                            • Added
                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                            • Changed
                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                            • Fixed
                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                            • 4.1.0 - 2020-05-18
                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                            • 4.0.0 - 2020-04-28
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                              • Breaking Changes
                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                              • Added
                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                              • Changed
                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                              • 4.0.0 - 2020-04-28
                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                              • 3.0.1 - 2020-03-04
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                • Fixed
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                • 3.0.1 - 2020-03-04
                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                • 3.0.0 - 2020-03-04
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                  • Breaking Changes
                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                  • 3.0.0 - 2020-03-04
                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                  • 2.0.0 - 2019-10-16
                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                    • Breaking Changes
                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                    • Added
                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                    • Changed
                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                    • Fixed
                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                    • 2.0.0 - 2019-10-16
                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                    • 1.2.2 - 2019-05-16
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                      • Added
                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                      • Changed
                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                      • 1.2.2 - 2019-05-16
                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                      • 1.2.1 - 2019-02-16
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                        • Added
                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                        • Fixed
                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                        • 1.2.1 - 2019-02-16
                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                        • 1.2.0 - 2019-02-04
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                          • Breaking Changes
                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                          • 1.2.0 - 2019-02-04
                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                          • 1.1.0 - 2018-12-27
                                                                                                                                                                                                                                                                          • Related Projects
                                                                                                                                                                                                                                                                            • diff --git a/docs/searchindex.js b/docs/searchindex.js index 0afab531..32113114 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","manual/creating-new-maps","manual/editing-map-collisions","manual/editing-map-connections","manual/editing-map-events","manual/editing-map-header","manual/editing-map-tiles","manual/editing-wild-encounters","manual/introduction","manual/navigation","manual/project-files","manual/region-map-editor","manual/scripting-capabilities","manual/settings-and-options","manual/shortcuts","manual/tileset-editor","reference/changelog","reference/related-projects"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":2,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","manual\\creating-new-maps.rst","manual\\editing-map-collisions.rst","manual\\editing-map-connections.rst","manual\\editing-map-events.rst","manual\\editing-map-header.rst","manual\\editing-map-tiles.rst","manual\\editing-wild-encounters.rst","manual\\introduction.rst","manual\\navigation.rst","manual\\project-files.rst","manual\\region-map-editor.rst","manual\\scripting-capabilities.rst","manual\\settings-and-options.rst","manual\\shortcuts.rst","manual\\tileset-editor.rst","reference\\changelog.md","reference\\related-projects.rst"],objects:{"":{onBlockChanged:[12,0,1,""],onBlockHoverChanged:[12,0,1,""],onBlockHoverCleared:[12,0,1,""],onBorderMetatileChanged:[12,0,1,""],onBorderResized:[12,0,1,""],onBorderVisibilityToggled:[12,0,1,""],onMainTabChanged:[12,0,1,""],onMapOpened:[12,0,1,""],onMapResized:[12,0,1,""],onMapShifted:[12,0,1,""],onMapViewTabChanged:[12,0,1,""],onProjectClosed:[12,0,1,""],onProjectOpened:[12,0,1,""],onTilesetUpdated:[12,0,1,""]},map:{addFilledRect:[12,0,1,""],addImage:[12,0,1,""],addMetatileImage:[12,0,1,""],addRect:[12,0,1,""],addText:[12,0,1,""],addTileImage:[12,0,1,"id1"],bucketFill:[12,0,1,""],bucketFillFromSelection:[12,0,1,""],clearOverlay:[12,0,1,""],clearOverlays:[12,0,1,""],commit:[12,0,1,""],createImage:[12,0,1,""],error:[12,0,1,""],getAllowBiking:[12,0,1,""],getAllowEscaping:[12,0,1,""],getAllowRunning:[12,0,1,""],getBaseGameVersion:[12,0,1,""],getBattleScene:[12,0,1,""],getBlock:[12,0,1,""],getBorderDimensions:[12,0,1,""],getBorderHeight:[12,0,1,""],getBorderMetatileId:[12,0,1,""],getBorderVisibility:[12,0,1,""],getBorderWidth:[12,0,1,""],getCollision:[12,0,1,""],getCustomScripts:[12,0,1,""],getDimensions:[12,0,1,""],getElevation:[12,0,1,""],getFloorNumber:[12,0,1,""],getGridVisibility:[12,0,1,""],getHeight:[12,0,1,""],getInputItem:[12,0,1,""],getInputNumber:[12,0,1,""],getInputText:[12,0,1,""],getLocation:[12,0,1,""],getMainTab:[12,0,1,""],getMapViewTab:[12,0,1,""],getMaxPrimaryTilesetMetatiles:[12,0,1,""],getMaxPrimaryTilesetTiles:[12,0,1,""],getMaxSecondaryTilesetMetatiles:[12,0,1,""],getMaxSecondaryTilesetTiles:[12,0,1,""],getMetatileAttributes:[12,0,1,""],getMetatileBehavior:[12,0,1,""],getMetatileEncounterType:[12,0,1,""],getMetatileId:[12,0,1,""],getMetatileLabel:[12,0,1,""],getMetatileLayerOpacity:[12,0,1,""],getMetatileLayerOrder:[12,0,1,""],getMetatileLayerType:[12,0,1,""],getMetatileTerrainType:[12,0,1,""],getMetatileTile:[12,0,1,""],getMetatileTiles:[12,0,1,""],getNumMetatileLayers:[12,0,1,""],getNumPrimaryTilesetMetatiles:[12,0,1,""],getNumPrimaryTilesetTiles:[12,0,1,""],getNumSecondaryTilesetMetatiles:[12,0,1,""],getNumSecondaryTilesetTiles:[12,0,1,""],getNumTilesInMetatile:[12,0,1,""],getOverlayOpacity:[12,0,1,""],getOverlayPosition:[12,0,1,""],getOverlayVisibility:[12,0,1,""],getOverlayX:[12,0,1,""],getOverlayY:[12,0,1,""],getPorymapVersion:[12,0,1,""],getPrimaryTileset:[12,0,1,""],getPrimaryTilesetPalette:[12,0,1,""],getPrimaryTilesetPalettePreview:[12,0,1,""],getPrimaryTilesetPalettes:[12,0,1,""],getPrimaryTilesetPalettesPreview:[12,0,1,""],getRequiresFlash:[12,0,1,""],getSecondaryTileset:[12,0,1,""],getSecondaryTilesetPalette:[12,0,1,""],getSecondaryTilesetPalettePreview:[12,0,1,""],getSecondaryTilesetPalettes:[12,0,1,""],getSecondaryTilesetPalettesPreview:[12,0,1,""],getShowLocationName:[12,0,1,""],getSmartPathsEnabled:[12,0,1,""],getSong:[12,0,1,""],getTilePixels:[12,0,1,""],getType:[12,0,1,""],getWeather:[12,0,1,""],getWidth:[12,0,1,""],hideOverlay:[12,0,1,""],hideOverlays:[12,0,1,""],isPrimaryTileset:[12,0,1,""],isSecondaryTileset:[12,0,1,""],log:[12,0,1,""],magicFill:[12,0,1,""],magicFillFromSelection:[12,0,1,""],moveOverlay:[12,0,1,""],moveOverlays:[12,0,1,""],redraw:[12,0,1,""],registerAction:[12,0,1,""],setAllowBiking:[12,0,1,""],setAllowEscaping:[12,0,1,""],setAllowRunning:[12,0,1,""],setBattleScene:[12,0,1,""],setBlock:[12,0,1,"id0"],setBlocksFromSelection:[12,0,1,""],setBorderDimensions:[12,0,1,""],setBorderHeight:[12,0,1,""],setBorderMetatileId:[12,0,1,""],setBorderVisibility:[12,0,1,""],setBorderWidth:[12,0,1,""],setCollision:[12,0,1,""],setDimensions:[12,0,1,""],setElevation:[12,0,1,""],setFloorNumber:[12,0,1,""],setGridVisibility:[12,0,1,""],setHeight:[12,0,1,""],setLocation:[12,0,1,""],setMainTab:[12,0,1,""],setMapViewTab:[12,0,1,""],setMetatileAttributes:[12,0,1,""],setMetatileBehavior:[12,0,1,""],setMetatileEncounterType:[12,0,1,""],setMetatileId:[12,0,1,""],setMetatileLabel:[12,0,1,""],setMetatileLayerOpacity:[12,0,1,""],setMetatileLayerOrder:[12,0,1,""],setMetatileLayerType:[12,0,1,""],setMetatileTerrainType:[12,0,1,""],setMetatileTile:[12,0,1,"id2"],setMetatileTiles:[12,0,1,"id3"],setOverlayOpacity:[12,0,1,""],setOverlayPosition:[12,0,1,""],setOverlayVisibility:[12,0,1,""],setOverlayX:[12,0,1,""],setOverlayY:[12,0,1,""],setOverlaysOpacity:[12,0,1,""],setOverlaysPosition:[12,0,1,""],setOverlaysVisibility:[12,0,1,""],setOverlaysX:[12,0,1,""],setOverlaysY:[12,0,1,""],setPrimaryTileset:[12,0,1,""],setPrimaryTilesetPalette:[12,0,1,""],setPrimaryTilesetPalettePreview:[12,0,1,""],setPrimaryTilesetPalettes:[12,0,1,""],setPrimaryTilesetPalettesPreview:[12,0,1,""],setRequiresFlash:[12,0,1,""],setSecondaryTileset:[12,0,1,""],setSecondaryTilesetPalette:[12,0,1,""],setSecondaryTilesetPalettePreview:[12,0,1,""],setSecondaryTilesetPalettes:[12,0,1,""],setSecondaryTilesetPalettesPreview:[12,0,1,""],setShowLocationName:[12,0,1,""],setSmartPathsEnabled:[12,0,1,""],setSong:[12,0,1,""],setTimeout:[12,0,1,""],setType:[12,0,1,""],setWeather:[12,0,1,""],setWidth:[12,0,1,""],shift:[12,0,1,""],showError:[12,0,1,""],showMessage:[12,0,1,""],showOverlay:[12,0,1,""],showOverlays:[12,0,1,""],showQuestion:[12,0,1,""],showWarning:[12,0,1,""],warn:[12,0,1,""]}},objnames:{"0":["js","function","JavaScript function"]},objtypes:{"0":"js:function"},terms:{"0e8ccfc4fd3544001f4c25fafd401f7558bdefba":16,"0x10":12,"0x11":12,"0x4":8,"0x8":12,"0x9":12,"32x20":13,"3x3":6,"4bpp":11,"82abc164dc9f6a74fdf0c535cc1621b7ed05318b":16,"8bpp":11,"8x8":[12,15],"boolean":12,"case":[2,4],"const":12,"default":[4,6,7,9,11,12,13,14,16],"export":[12,15,16],"final":8,"function":[4,8,11,16],"goto":4,"import":[2,12,16],"long":[2,12,16],"new":[0,2,3,4,6,9,10,11,12,13,14,15,16],"pok\u00e9":6,"pok\u00e9cent":4,"pok\u00e9mon":[4,6,9,16],"return":[4,12],"switch":[9,12,15,16],"true":[2,12],"try":[2,12],"var":[4,10],"while":[2,4,6,12,14,16],AND:4,Adding:0,For:[1,2,3,4,5,6,7,9,11,12,13,14,15,16],Its:[8,16],NOT:12,One:[7,12],That:8,The:[0,1,2,4,5,6,7,8,9,12,13,16],Then:[2,6,7,12],There:[4,8,11,12,13,15],These:[2,3,6,7,12,15],Use:[4,6],Used:[5,15],Useful:12,Will:12,With:[4,12],Yes:12,a0ba1b7c6353f7e4f3066025514c05b323a0123d:16,a1ea3b5e394bc115ba9b86348c161094a00dcca7:16,aarrggbb:12,abil:[2,4,12,16],abl:[2,4,11,12],about:[0,12,16],abov:[2,4,6,8,9,11,12,15,16],accept:7,access:[4,12,15],accomod:16,accomplish:6,accord:16,account:[],accur:16,across:15,act:16,action:[0,6,14],actionnam:12,activ:[4,7,12],actual:[4,12,16],ad365a35c1536740cbcbc10bee66e5dd908c39e7:16,adb0a444577b59eb02788c782a3d04bc285be0ba:16,add:[1,3,4,7,11,12,13,15,16],added:[12,16],addfilledrect:12,addimag:12,adding:[7,13,16],addit:[5,8,12,15],addition:[4,6],addmetatileimag:12,addrect:12,addtext:12,addtileimag:12,adher:16,adjac:[4,12],adjust:[6,7,15],adob:15,advanc:[8,16,17],affect:12,after:[2,4,6,8,12,16],again:[4,6],alia:11,all:[2,3,4,6,7,9,11,12,14,15,16],allow:[1,2,4,5,6,7,8,9,12,13,15,16],along:2,alreadi:14,also:[2,4,5,6,7,10,11,12,13,14,15,16],alter:7,altern:[1,4],altogeth:15,alwai:[2,4,16],ani:[1,2,4,6,9,11,12,13,15,16],anim:[4,12,16],anoth:[4,6,7,9,11],anyth:[4,6],api:[0,16],app:13,appdata:[13,14],appear:[4,6,9,11,12,16],append:[5,10],appli:12,applic:[9,13,14,16],applymov:4,applynighttint:12,appropri:2,area:[2,4,6,8,9,11,12,16],argument:[12,15,16],around:[4,6,9,11,13,16],arrai:[11,12],arriv:4,arrow:[4,16],assign:[4,7],associ:[1,2,4,11,15],assum:[12,16],attempt:15,attribut:[12,15,16],auto:16,autocomplet:16,automat:[3,4,5,12,15,16],avail:[4,6,7,8,9,11],awai:7,awar:6,axi:6,back:[6,16],background:[0,5,9,12,15],bar:[12,16],base:[0,1,7,11,12,13,16],base_game_vers:[13,16],basement:5,basic:[2,6,8,9],battl:[4,5,12],battlescen:12,becaus:[2,4,9],becom:16,been:16,befor:[2,6,8,12,16],begin:[],behav:[4,12,16],behavior:[12,16],behind:12,being:[2,8,16],bele:1,belong:5,below:[2,4,6,7,12,16],berri:4,better:16,between:[2,3,4,9,11,12,15,16],beyond:16,bigger:6,bike:[1,5,12],binari:[8,11,15],bit:[12,15,16],black:12,blank:[],block:[1,2,12,16],blockdata:10,blue:4,boi:17,border:[0,1,4,10,12,13,16],both:[3,6,15,16],bottom:[6,12,15,16],bound:[4,16],boundari:16,box:[4,7,11,12,13,15,16],bread:6,bridg:2,brief:4,briefli:9,bring:[4,6,7,9,11],browser:12,brush:12,bucket:[0,12,14],bucketfil:12,bucketfillfromselect:12,bug:16,build:[4,6,8,12],built:[6,16],bulk:16,bump:16,butter:6,button:[0,3,6,7,8,9,11,12,13,16],bvd:[15,16],c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3:16,c73de8bed752ca538d90cfc93c4a9e8c7965f8c9:16,cach:12,call:[6,12,16],callabl:12,callback:16,can:[0,1,2,3,4,5,6,7,8,9,11,12,13,14,15,16],cancel:[12,14],cannot:[1,4,5,14,16],capabl:[0,16],categori:15,caus:16,cave:7,cdae0c1444bed98e652c87dc3e3edcecacfef8b:16,ceil:12,center:[1,4,6,9,16],certain:[4,10,12,15,16],cfg:[6,12,13,14,16],chain:6,chanc:7,chang:[0,1,3,4,7,8,9,11,12,13],changelog:0,charact:[4,16],check:[4,6,7,9,12,16],checkbox:[3,6,16],choos:[4,6,7,8,9,12],citi:[3,8],clear:[11,12,16],clearoverlai:12,click:[1,2,3,4,6,7,8,9,11,12,13,14,16],cliff:2,clipboard:16,clone:[0,13,16],close:[4,12,16],code:[4,12,15],collaps:[9,16],collect:5,collid:12,collis:[0,4,6,8,9,12,13,16],collision_opac:13,color:[12,13,15,16,17],column:2,com:[0,13,16],combin:15,combo:[4,13,16],combobox:[11,16],comma:12,command:[4,13,14,16],comment:16,commit:[12,16],commitchang:12,common:2,commonli:2,compat:16,compil:8,complet:12,compos:[],comprehens:[14,16],concept:2,config:[6,12,13,16],configur:[0,6,11,12,13,16],conjunct:6,connect:[0,4,6,8,9,12,16],consecut:12,consist:[12,16],constant:[10,11,12,15],contain:[4,9,13,15,16],context:[9,15],contigu:[6,16],continu:[2,6],control:[2,4,5,8],conveni:[4,6,15,16],convert:15,coordin:[4,11,12,16],coorespond:16,copi:[6,7,16],corner:[3,12],correctli:16,correspond:[11,16],corrupt:16,could:[12,16],count:[2,15,16],coupl:11,cover:[4,9,15],crash:16,creat:[0,4,6,7,9,11,12,13,16],create_map_text_fil:13,createimag:12,creation:6,critic:12,cross:8,crosshair:13,ctrl:[3,4,6,8,9,11,12,14,16],cumbersom:12,current:[2,4,6,7,8,9,11,12,14,15,16],cursor:[4,6,11,13,14,16],custom:[0,1,5,6,11,13,14,16],custom_script:[12,13],dai:[7,12],dark:16,data:[6,7,8,10,11,12,13,15,16],date:16,daunt:9,deactiv:4,debug:12,decim:12,decompil:[8,16,17],defin:[6,11,12,15,16],del:[14,16],delai:12,delaym:12,delet:[0,3,11,14,15,16],deltai:12,deltax:12,demand:12,demonstr:6,denot:2,depend:[1,6,12,13,16],depth:15,describ:[4,7],descript:[4,13],design:6,desir:[3,6,9],despit:16,destin:[3,4],detail:[4,6,9,11,12,16],detailedtext:12,detect:12,determin:[2,4,11,13,15],diagonist:12,dialog:[8,9,12,14,16],did:16,diff:16,differ:[1,2,4,6,9,11,12,15,16],difficulti:8,dig:[5,12],dimens:[6,11,12,13,16],direct:[2,3,4,6,16],directli:[4,12],directori:12,disabl:[6,7,16],disallow:16,disassembl:17,disk:[7,12],displai:[1,4,6,7,8,11,12,13,15,16],dissect:4,distanc:[4,16],distinguish:11,dive:0,document:[12,16],doe:[4,6,8,12],doesn:[2,6,12,16],doing:8,don:[3,16],done:11,doubl:[3,4,9,11,16],down:[6,7,8,16],download:8,drag:[3,4,6,11,14,16],draw:[4,8,11,14,15,16],drawn:12,drop:7,dropdown:[3,6,12,15,16],due:16,dummi:4,duplic:[4,14,16],dure:[2,4,16],dynam:4,each:[2,4,5,7,9,11,12,15,16],easi:[1,4,6],easier:[6,11,15,16],easiest:3,east:[2,3],ecmascript:12,edit:[0,8,9,10,11,13,14,15,16],editor:[0,4,8,12,13,16,17],effect:[15,16],either:[2,6,9,12,15],element:[12,16],elev:[1,2,4,12],els:[2,4],emerg:0,empti:[7,8,16],enabl:[3,6,12,13,16],enable_event_clone_object:13,enable_event_secret_bas:13,enable_event_weather_trigg:13,enable_floor_numb:13,enable_heal_location_respawn_data:13,enable_hidden_item_quant:13,enable_hidden_item_requires_itemfind:13,enable_object_event_in_connect:[],enable_triple_layer_metatil:[12,13],encount:[0,12,13,16],encountertyp:12,end:[10,16],endless:12,enforc:7,engin:[4,5,13],enhanc:12,ensur:4,enter:[1,2,4,5,9,11,12,14],entir:[6,11,12,15,16],entranc:4,entri:[0,12],equal:4,equival:8,eras:12,error:[12,16],escap:[1,5,12],essenti:12,etc:16,evalu:16,even:[6,14],event:[0,1,3,8,9,12,13,14,16],event_bg:10,event_object_mov:10,event_script:10,everi:[6,11,15],exactli:6,exampl:[1,2,3,4,5,6,11,12,15,16],except:[2,4],exchang:11,exclus:[4,5,15],execut:[4,12,13],exist:[1,4,6,8,11,12,16],exit:[12,16],expand:[5,9,16],expens:12,explain:4,explan:11,explanatori:5,explicitli:16,explor:2,express:16,extend:[4,16],extens:[4,12,16],extra:16,extrem:3,eyedropp:[6,14,15],face:[4,15,16],fake:12,fall:16,fals:12,familiar:8,fan:16,featur:[2,3,8,9,11,16],feel:0,few:[4,6,8,9],fewer:[],field:[0,4,5,6,11,16],fieldmap:10,file:[0,3,4,6,8,9,11,12,13,15,16],filepath:[11,12,13],fill:[0,2,12,14,16],filter:[9,16],find:0,finish:[2,11],first:[2,4,7,8,9,11,12,13,16],fit:16,fix:6,flag:[4,10,16],flash:[5,12],flip:[11,12,16],floor:[1,5,12,13],floornumb:12,flow:[2,6],flower:8,floweri:8,fly:[1,4],focu:16,folder:[1,8,9,16],follow:[0,6,8,12],font:12,forc:12,forceredraw:12,fork:12,form:[12,15],format:[6,11,15,16,17],found:[4,8,15,16],four:7,frame:16,frlg:16,from:[1,2,4,6,7,8,9,10,11,12,14,16,17],front:4,full:[12,16],fullest:9,func:12,functionnam:12,futur:[],game:[2,4,5,6,7,8,9,11,12,16,17],gameplai:[2,4,9],gba:[13,15],gen:[8,17],gener:[2,8,10,12,14,15],get:[0,6,12,16],getallowbik:12,getallowescap:12,getallowrun:12,getbasegamevers:12,getbattlescen:12,getblock:12,getborderdimens:12,getborderheight:12,getbordermetatileid:12,getbordervis:12,getborderwidth:12,getcollis:12,getcustomscript:12,getdimens:12,getelev:12,getfloornumb:12,getgridvis:12,getheight:12,getinputitem:12,getinputnumb:12,getinputtext:12,getloc:12,getmaintab:12,getmapviewtab:12,getmaxprimarytilesetmetatil:12,getmaxprimarytilesettil:12,getmaxsecondarytilesetmetatil:12,getmaxsecondarytilesettil:12,getmetatileattribut:12,getmetatilebehavior:12,getmetatileencountertyp:12,getmetatileid:12,getmetatilelabel:12,getmetatilelayeropac:12,getmetatilelayerord:12,getmetatilelayertyp:12,getmetatileterraintyp:12,getmetatiletil:12,getnummetatilelay:12,getnumprimarytilesetmetatil:12,getnumprimarytilesettil:12,getnumsecondarytilesetmetatil:12,getnumsecondarytilesettil:12,getnumtilesinmetatil:12,getoverlayi:12,getoverlayopac:12,getoverlayposit:12,getoverlayvis:12,getoverlayx:12,getporymapvers:12,getprimarytileset:12,getprimarytilesetpalett:12,getprimarytilesetpalettepreview:12,getprimarytilesetpalettespreview:12,getrequiresflash:12,getsecondarytileset:12,getsecondarytilesetpalett:12,getsecondarytilesetpalettepreview:12,getsecondarytilesetpalettespreview:12,getshowlocationnam:12,getsmartpathsen:12,getsong:12,gettilepixel:12,gettyp:12,getweath:12,getwidth:12,gif:[6,16],git:[4,8],github:[0,13,16],give:[4,6,7,9,16],given:[7,12,15,16],global:[4,10,12,13],goe:12,going:[4,14],good:[10,12],gpl:16,graphic:[4,5,10,16],graphics_file_rul:15,grass:[2,8,12,15],grasstil:12,great:8,green:[4,7],greet:8,grid:[6,12,14,16],group:[0,1,6,9,13,14,16],grow:16,guarante:16,hack:[8,15],half:2,handl:16,happen:[4,12,16],hardcod:[4,16],hardwar:15,has:[2,3,4,5,9,11,14,15,16],have:[2,3,4,6,7,8,9,11,12,14,15,16],head:11,headbutt_mon:7,header:[0,9,10,13,16],heal:[0,1,13,16],heal_loc:[4,10],healspot:0,height:[1,11,12],help:[6,15,16],here:[2,12,14,15],hex:[15,16],hexadecim:2,hidden:[0,6,12,13,16],hide:[1,5,12,16],hideoverlai:12,hierarch:9,high:17,higher:12,highli:8,higlight:11,histori:[2,12,14,16],hit:16,hold:[4,6,14,16],home:16,hop:2,horizont:[3,12,16],hous:16,hover:[6,13,16],how:[2,4,6,8,9,12],howev:[4,6,12],hscale:12,http:[0,13,16],huderlem:[0,16],huge:16,ice:15,icon:[6,10,12,16],idea:10,ident:[2,6],ids:12,ignor:[8,16],illustr:[2,6],imag:[0,4,6,10,12,16],immedi:16,impass:[2,12],implement:7,implicitli:12,improperli:16,improv:8,inanim:16,inc:[4,10,13,16],includ:[2,4,6,7,9,10,11,15,16],inclus:12,incompat:6,incorrect:16,increment:12,index:[7,12,15,16],indexof:12,indic:[6,12,15],individu:[6,12,15,16],indoor:1,info:12,inform:[12,16],informativetext:12,inherit:4,initi:[12,16],input:[12,16],insert:12,insid:4,instal:8,instanc:11,instead:[4,12,16],integ:[11,16],integr:[10,16],interact:[2,4,9,12],interest:12,interpret:16,interv:12,introduc:16,introduct:0,invalid:16,invis:[4,12],involv:4,isprimarytileset:12,issecondarytileset:12,issu:16,item:[0,5,10,12,13,16],itemfind:[4,13],iter:16,its:[4,6,16],itself:12,jasc:[15,16],javascript:[12,16],json:[6,7,10,11,13,16],jump:16,junk:16,just:[1,2,6,7,15],kanto:16,keep:[3,5,16],kei:[6,14,16],keyboard:[11,12,14,16],keyword:12,known:4,label:[11,12,16],laid:6,land:[2,12],languag:17,larg:[6,16],larger:[6,9],last:[12,16],later:12,launch:[8,12,13,16],layer:[12,13,16],layertyp:12,layout:[0,1,9,10,16],layouts_t:16,learn:[6,8,9],leav:2,left:[2,4,6,8,9,11,12,14,15,16],length:12,let:[2,4,6,7,8,9,11,12,17],letter:12,level:[2,7,10,16,17],librari:[13,14],life:[4,6],like:[2,4,6,9,15,16],limit:[5,12,15,16],line:[4,6,16],link:[],linux:[8,16],list:[0,1,4,6,10,11,12,13,14,16],listen:17,littl:4,load:[4,8,9,12,13,16],local:4,locat:[0,1,5,6,8,11,12,13,16],lock:[4,6,16],log:[12,16],logic:12,longer:[4,16],look:[0,4,8,9,11],lot:15,lower:[12,16],mac:[8,16],maco:[13,14,16],macro:15,made:[7,16],magic:[12,14,16],magicfil:12,magicfillfromselect:12,mai:[1,4,7,15],main:[0,6,7,8,11,12,16],main_splitter_st:13,maintain:[2,10],major:[12,16],make:[2,4,6,8,11,12,15,16],makefil:15,mani:[4,8,9,11,12,14],manipul:[7,12],manual:[0,12,13],map:[0,7,8,10,13,16,17],map_group:10,map_groups_count:16,map_sort_ord:13,map_splitter_st:13,map_typ:10,map_type_indoor:5,mapnam:12,mapsec_new_mapsec:[],mapsec_non:11,mark:4,mart:6,match:[4,6,16],math:12,max:[10,12,16],maximum:[7,12,16],mean:[2,3,4,12],meant:17,measur:[4,16],memori:12,menu:[0,3,7,12,13,16],messag:[12,16],metatil:[0,1,2,4,8,9,10,12,13,14,16],metatile_behavior:[10,15],metatile_id:15,metatile_label:[10,15,16],metatileid:12,metatiles_zoom:13,method:[6,16],middl:[6,12,14,15,16],might:[7,12],millisecond:12,mimic:16,min:[10,12,16],minimum:[7,12],minor:[12,16],mirror:0,miscellan:[5,12],miss:[0,16],mistak:[6,11],mode:[1,9,14,16],modif:2,modifi:[6,9,11,12,15,16],monitor:[13,16],monitor_fil:13,more:[4,6,8,9,11,14,15,16],most:[2,8,9,11,13,16],mostli:5,mountain:[2,6],mous:[4,6,11,12,16],move:[2,3,4,5,12,14,16],movement:[4,16],moveoverlai:12,much:8,multi:[2,16],multilin:16,multipl:[4,6,7,11,12,14,16],music:[5,9,16,17],must:[3,4,6,7,8,12,15],my_script:12,name:[1,4,5,6,7,9,10,11,12,15,16],navig:[0,3,4,7,8,11,16],nearli:2,need:[2,3,4,5,6,11,15,16],neg:[5,11,12,16],never:4,newblock:12,newheight:12,newli:[12,16],newmetatileid:12,newtab:12,newwidth:12,next:[2,4,7,8,9,12,13,16],nice:12,night:12,nodej:12,nodep:8,non:[4,11],none:12,normal:[4,6,15],north:2,notabl:[8,16],note:[5,10],noth:[4,12],notic:11,now:[2,6,7,8,12,16],npc:[4,13],num_til:15,number:[1,2,4,5,7,12,13,16],object:[0,2,6,9,12,13,16],object_ev:10,object_event_graph:10,object_event_graphics_info:[10,16],object_event_graphics_info_point:10,object_event_pic_t:10,occur:[12,16],odd:[],off:[2,6,12,16],offici:16,offset:[3,11,12,16],old:[14,16],oldheight:12,oldtab:12,oldwidth:12,onblockchang:[12,16],onblockhoverchang:12,onblockhoverclear:12,onbordermetatilechang:12,onborderres:12,onbordervisibilitytoggl:12,onc:[4,6,12],one:[2,3,6,7,9,11,12],onli:[2,3,4,6,7,9,10,12,15,16],onmaintabchang:12,onmapopen:12,onmapres:12,onmapshift:12,onmapviewtabchang:12,onprojectclos:12,onprojectopen:12,ontilesetupd:12,onto:[2,6,9,11,12],opac:[12,13,16],opaqu:12,open:[0,3,6,7,8,9,11,12,13,14,15,16],oper:[9,12,15,16],oppon:10,optim:6,option:[0,4,9,11,12,13,14,15,16],order:[1,4,7,12,13,16],organ:9,origin:[4,12,16],other:[4,6,9,11,12,16,17],otherwis:[7,10,12],our:[7,8,12],out:[0,4,6,7,9,11,12,14,16],outdoor:1,outlin:[6,12,14,16],output:15,outsid:16,over:[2,4,5,6,9,16],overhaul:16,overlai:[13,16],overload:12,overview:12,overworld:4,overwrit:[12,14],overwritten:12,own:12,paint:[0,6,8,9,11,12,14,16],pal:[11,15,16],palett:[0,10,11,12,16],paletteid:12,paletteindex:12,pane:[6,9,11,15,16],panel:[8,15,16],pars:16,part:9,partial:[6,16],particular:2,particularli:4,passabl:12,past:16,patch:12,path:[0,2,11,12,14,16],pathwai:6,patient:9,pattern:[6,12],pencil:[0,4,8,14,16],per:[14,16],perform:[6,12],perman:12,petalburg:[3,8],pick:[4,15],picker:[6,16],pictur:[7,15,16],pink:4,pixel:[12,15,16],place:[4,6,8,11,12,16],placehold:16,plai:5,plain:[11,16],plain_grass:15,platform:[8,13],player:[1,2,3,4,6,9,11,14,15,16],pleas:0,plu:[3,4],png:[15,16],pointer:[0,4,14,16],pokecryst:17,pokeemerald:[4,6,8,10,11,12,13,16],pokefir:[4,5,6,8,11,12,13,15,16],pokemon:[1,7,9,10,12,16],poker:17,pokerubi:[4,6,8,10,12,16],polish:17,pond:6,pop:8,popul:[7,11,12,15],popular:17,popup:[1,5,11],pori:[4,13,16],port:16,portion:6,porycript:4,porymap:[1,3,4,6,7,9,10,11,12,14,15,16],poryscript:[16,17],posit:[0,6,11,12,16],possibl:[7,12,16],power:[6,12],pre:[6,16],prefab:[0,13],prefabr:6,prefabs_filepath:13,prefer:[4,14,16],prefix:[5,12,16],present:16,preserv:16,press:[3,4,6,8,9,16],pret:[8,13,14,16],pretti:7,pretty_cursor:13,prevblock:12,prevent:16,preview:[6,12],previou:2,previous:12,prevmetatileid:12,primari:[1,6,8,12,15],pro:15,probabl:[10,12],procedur:12,process:[2,4],program:17,project:[0,1,4,5,6,8,9,11,12,13,14,15,16],project_root:[6,13],projectpath:12,prompt:[14,16],proper:16,properli:16,properti:[0,2,4,5,8,9,11,12,16],provid:[4,6,7,8,12,15,16],pull:16,purpos:[2,9],qt6:16,quantiti:[4,13],question:12,quick:6,quickli:9,radiu:[4,6,13],randint:12,random:12,rang:[4,12],rate:7,rather:[6,12,16],ratio:7,raw:[12,16],rawvalu:12,reach:0,read:[4,8,10,11,12,13,16],realist:15,reason:[7,15],receiv:4,recent:[13,16],recent_map:13,recent_project:13,recommend:8,rectangl:[6,12,13,16],red:[2,7],redo:[0,2,4,8,11,14,16],redraw:12,reduc:16,refer:[0,14],referenc:15,refresh:12,region:[0,1,5,6,8,12,13,16],region_map:[10,11],region_map_dimens:13,region_map_entri:10,region_map_sect:[10,11],regist:[0,16],registeract:12,registri:16,regress:16,regular:6,rejoic:16,rel:[11,12],relat:[0,10,12],releas:[6,8,16],reli:10,reload:16,remain:12,rememb:[2,12],remov:15,render:[12,16],reopen_on_launch:13,reorder:16,replac:[11,16],repo:[13,16],report:16,repres:[2,7,12],requir:[4,5,12,13,16],reselect:16,reset:[11,14,16],resili:16,resiz:[6,16],resolut:16,respawn:[4,13],respect:[8,16],rest:12,restor:[13,14,16],restrict:11,result:8,retriev:12,rgb:[12,16],right:[1,2,3,4,6,7,9,11,12,14,15,16],rival:4,rme:11,rom:8,rooftop:5,root:[11,13],rope:[1,5,12],rout:[2,3],row:[2,16],rrggbb:12,rubi:5,rule:15,ruler:[0,16],run:[1,5,12],same:[2,4,6,8,12,14,16],save:[3,6,7,8,12,14,15,16],scale:[12,13,14],scenario:[15,16],scene:[5,12],scratch:[11,15],screen:[7,8,13,15,16],script:[0,9,10,13,16,17],scroll:6,seamlessli:3,second:[2,8,9],secondari:[1,6,12,15],secret:[0,13,16],secret_bas:[4,10],section:[1,4,5,6,9,11],see:[1,4,6,7,8,9,12,13],seem:9,seen:16,select:[0,3,4,7,8,9,11,12,14,15,16],selector:[2,6,11,16],self:5,semant:16,sensibl:16,separ:12,session:16,set:[0,4,6,7,9,11,14,15,16],setallowbik:12,setallowescap:12,setallowrun:12,setbattlescen:12,setblock:12,setblocksfromselect:12,setborderdimens:12,setborderheight:12,setbordermetatileid:12,setbordervis:12,setborderwidth:12,setcollis:12,setdimens:12,setelev:12,setfloornumb:12,setgridvis:12,setheight:12,setloc:12,setmaintab:12,setmapviewtab:12,setmetatileattribut:12,setmetatilebehavior:12,setmetatileencountertyp:12,setmetatileid:12,setmetatilelabel:12,setmetatilelayeropac:12,setmetatilelayerord:12,setmetatilelayertyp:12,setmetatileterraintyp:12,setmetatiletil:12,setoverlayi:12,setoverlayopac:12,setoverlayposit:12,setoverlaysi:12,setoverlaysopac:12,setoverlaysposit:12,setoverlaysvis:12,setoverlaysx:12,setoverlayvis:12,setoverlayx:12,setprimarytileset:12,setprimarytilesetpalett:12,setprimarytilesetpalettepreview:12,setprimarytilesetpalettespreview:12,setrequiresflash:12,setsecondarytileset:12,setsecondarytilesetpalett:12,setsecondarytilesetpalettepreview:12,setsecondarytilesetpalettespreview:12,setshowlocationnam:12,setsmartpathsen:12,setsong:12,settimeout:12,settranspar:12,settyp:12,setup:8,setweath:12,setwhiteoutrespawnwarpandhealernpc:4,setwidth:12,sever:[7,12,13,15],shape:12,share:16,shift:[0,3,4,12,14,16],shoe:5,shortcut:[0,2,6,8,11,12,16],should:[2,4,6,7,8,11,12,13],shouldn:8,show:[1,5,6,8,9,12,14,15,16],show_cursor_til:13,show_player_view:13,showerror:12,showmessag:12,shown:12,showoverlai:12,showquest:12,showwarn:12,shrink:16,side:[2,3,6,8,9,15],sight:4,sign:[0,16],signific:16,signpost:[2,4],similar:[2,3,7],simpl:[4,7],simpli:[3,4,6,9,11,15],simplifi:6,simultan:11,sinc:[3,8,12,15,16],singl:[7,9,11,12],situat:[9,16],size:[6,11,12,13,16],slider:[2,6,11,15,16],slot:7,slow:12,small:4,smaller:12,smart:[0,2,12,14,16],smooth:16,snap:6,some:[1,2,4,6,8,9,12,13,16],someth:[0,2,4,7,11],sometim:16,somewhat:16,song:[5,12],sort:[1,9,13,16],sourc:[8,15],south:2,space:16,span:11,speci:7,special:[2,4],specif:[4,13,16],specifi:[4,12,16],specifii:12,spinbox:11,spinner:[4,12,15,16],split:15,spot:4,sprint:1,sprite:[4,10,16],squar:[4,11,16],src:[4,10,11],ssecretbaseentrancemetatil:4,stai:16,stair:2,stand:[4,15],standard:4,start:[0,2,6,12],startup:16,state:12,statu:16,step:12,still:16,stitch:16,stop:12,store:[11,13,14,16],straight:[0,14,16],straightforward:7,strict:[],string:[11,12,16],struct:16,studio:17,successfulli:[8,12],suffici:[11,12],summar:9,support:[5,6,8,11,12,13,14,16],sure:[2,3,8],surf:2,surround:[6,9],swap:11,symbol:16,sync:[3,16],system:16,tab:[0,2,3,4,6,7,9,12,16],tabl:[13,15,16],take:[6,7,8,9,11,12,16],taken:16,tall:15,target:[4,12],technic:[4,12],templat:16,temporarili:[6,16],terrain:12,terraintyp:12,test:12,text:[2,4,9,12,13,16],text_editor_goto_lin:13,text_editor_open_directori:13,than:[6,12,16],thei:[1,3,4,5,6,9,12,14,15],them:[2,3,4,5,6,7,12,16],theme:[13,16],therefor:[7,8],thi:[1,2,3,4,5,6,7,9,10,11,12,13,15,16],thing:[4,5,6,7,8,9],think:[6,8],those:[8,12],though:[6,16],three:[4,11],through:[2,3,16],tied:[],tile:[0,2,4,8,9,10,11,12,16],tileend:12,tileid:12,tileindex:12,tilemap:[11,13,16,17],tileset:[0,1,8,10,11,16],tilesetnam:12,tilestart:12,time:[2,4,6,7,8,9,12,13,15,16],timelaps:16,tint:12,titl:12,togeth:[3,4,6,12,14,15],toggl:[6,12,13,14,16],toggld:16,too:[2,16],tool:[0,1,2,8,11,12,16],toolbar:[6,8],toolbutton:[14,15],top:[2,3,4,11,12,15,16],total:[2,7],tpl:16,tradit:8,trainer:[4,10,16],trainer_sight_or_berry_tree_id:16,trainer_typ:[10,16],trainer_type_norm:4,transform:12,transit:[2,4],transpar:[2,12,16],tree:[4,6],trigger:[0,9,12,13],tripl:[13,16],turn:16,two:[3,6,9,11,15],type:[0,1,4,5,9,11,12,16],typic:[2,4],ubuntu:16,unabl:2,unavail:4,uncheck:11,uncommit:12,under:[2,11],underli:[12,16],underscor:12,undertand:2,underw:16,undo:[0,2,4,8,11,12,14,16],undoabl:16,unexpect:16,unfortun:4,unhappi:11,uniq:7,uniqu:[4,11],unknown:16,unless:10,unlik:2,unlock:4,unreleas:0,unsav:16,until:7,unus:[15,16],updat:[2,3,6,12,16],upstream:16,usabl:8,usag:15,use:[1,2,4,6,7,8,9,11,12,13,14,15,16],use_custom_border_s:[6,12,13,16],use_encounter_json:13,use_poryscript:[13,16],usecach:12,used:[2,3,4,5,6,9,12,14,15,16,17],useful:[3,4,5,6,12,15],user:[0,1,2,8,10,11,12,13,15,16],uses:[2,4,6,7,12,13,15,16],using:[4,6,8,12,14,16],usual:12,valid:[11,16],valu:[3,4,5,6,11,12,15,16],vanilla:7,var_valu:16,variabl:[4,13],varieti:15,variou:[5,6,8,9,16],veri:[2,3,4,6,12],version:[2,4,5,8,12,16],vertic:[3,12,16],via:[6,12,13,16],video:17,view:[2,3,4,5,6,9,11,12,14,16],visibl:[4,6,12,16],vision:5,visual:[0,2,16],vscale:12,wai:[3,4,6,12],wait:12,walk:[2,3,4,9],want:[7,11,12],warn:[12,16],warp:[0,9,15,16],wasn:16,watch:16,water:[12,15],waterfal:12,weather:[0,5,9,10,12,13],web:12,websit:16,were:[4,6,12,16],weren:16,west:[2,3],what:[0,2,4,5,6,9,11],wheel:6,when:[1,2,3,4,5,6,8,9,11,12,13,15,16],whenev:[2,6,12,15],where:[4,6,11,12,15,16],whether:[1,2,5,12,13,15],which:[1,2,3,5,6,7,9,11,12,15,16],whichev:6,white:[2,4,6],whose:16,why:2,widget:[13,16],width:[1,11,12],wiki:13,wild:[0,9,12,13,15,16],wild_encount:10,window:[0,1,4,5,6,7,8,11,12,13,15,16],window_geometri:13,window_st:13,within:[4,9,14,15],without:[6,11,12,16],woman:4,won:[2,12],work:[6,8,9,15,16],workflow:[6,8,12],would:[2,12,16],wouldn:16,wrap:6,write:[0,8,10,16],written:16,wsl:16,xdelta:12,xflip:12,ydelta:12,yes:[10,13],yet:[],yflip:12,you:[0,1,2,3,4,5,6,7,8,9,11,14,15,16,17],your:[1,3,4,5,6,7,8,9,11,13,14],yourself:[10,14],zoom:[6,11,14,16]},titles:["Porymap Documentation","Creating New Maps","Editing Map Collisions","Editing Map Connections","Editing Map Events","Editing Map Headers","Editing Map Tiles","Editing Wild Encounters","Introduction","Navigation","Project Files","The Region Map Editor","Scripting Capabilities","Porymap Settings","Shortcuts","The Tileset Editor","Changelog","Related Projects"],titleterms:{"break":16,"function":12,"import":15,"new":[1,7],Added:16,Adding:[4,7],The:[11,15],about:8,action:12,advanc:15,api:12,background:11,base:4,behavior:15,border:6,bucket:6,button:4,callback:12,capabl:12,chang:[6,15,16],changelog:16,citi:[],clone:4,collis:2,configur:7,connect:3,creat:1,custom:12,delet:4,dive:3,document:0,edit:[2,3,4,5,6,7,12],editor:[9,11,14,15],emerg:3,encount:[7,15],entri:11,event:4,field:7,file:10,fill:6,fix:16,follow:3,from:15,get:8,group:7,header:[5,12],heal:4,healspot:4,hidden:4,imag:[11,15],introduct:8,item:4,label:15,layer:15,layout:11,list:9,locat:4,main:[9,14],map:[1,2,3,4,5,6,9,11,12,14,15],menu:15,metatil:[6,15],mirror:3,navig:9,number:15,object:4,open:4,option:[1,6],other:15,overlai:12,paint:2,palett:15,path:6,pencil:6,pointer:6,porymap:[0,8,13],posit:4,prefab:6,project:[10,17],properti:15,redo:6,region:[9,11,14],regist:12,relat:17,ruler:4,script:[4,12],secret:4,select:[2,6],set:[12,13],shift:6,shortcut:14,sign:4,smart:6,start:8,straight:6,tab:11,terrain:15,tile:[6,15],tileset:[6,9,12,14,15],tool:[4,6,15],trigger:4,type:[2,15],undo:6,unreleas:16,util:12,visual:6,warp:[3,4],weather:4,wild:7,window:[9,14],write:12}}) \ No newline at end of file +Search.setIndex({docnames:["index","manual/creating-new-maps","manual/editing-map-collisions","manual/editing-map-connections","manual/editing-map-events","manual/editing-map-header","manual/editing-map-tiles","manual/editing-wild-encounters","manual/introduction","manual/navigation","manual/project-files","manual/region-map-editor","manual/scripting-capabilities","manual/settings-and-options","manual/shortcuts","manual/tileset-editor","reference/changelog","reference/related-projects"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":2,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","manual\\creating-new-maps.rst","manual\\editing-map-collisions.rst","manual\\editing-map-connections.rst","manual\\editing-map-events.rst","manual\\editing-map-header.rst","manual\\editing-map-tiles.rst","manual\\editing-wild-encounters.rst","manual\\introduction.rst","manual\\navigation.rst","manual\\project-files.rst","manual\\region-map-editor.rst","manual\\scripting-capabilities.rst","manual\\settings-and-options.rst","manual\\shortcuts.rst","manual\\tileset-editor.rst","reference\\changelog.md","reference\\related-projects.rst"],objects:{"":{onBlockChanged:[12,1,1,""],onBlockHoverChanged:[12,1,1,""],onBlockHoverCleared:[12,1,1,""],onBorderMetatileChanged:[12,1,1,""],onBorderResized:[12,1,1,""],onBorderVisibilityToggled:[12,1,1,""],onMainTabChanged:[12,1,1,""],onMapOpened:[12,1,1,""],onMapResized:[12,1,1,""],onMapShifted:[12,1,1,""],onMapViewTabChanged:[12,1,1,""],onProjectClosed:[12,1,1,""],onProjectOpened:[12,1,1,""],onTilesetUpdated:[12,1,1,""]},"constants.version":{major:[12,0,1,""],minor:[12,0,1,""],patch:[12,0,1,""]},constants:{base_game_version:[12,0,1,""],layers_per_metatile:[12,0,1,""],max_primary_metatiles:[12,0,1,""],max_primary_tiles:[12,0,1,""],max_secondary_metatiles:[12,0,1,""],max_secondary_tiles:[12,0,1,""],tiles_per_metatile:[12,0,1,""]},map:{bucketFill:[12,1,1,""],bucketFillFromSelection:[12,1,1,""],commit:[12,1,1,""],getAllowBiking:[12,1,1,""],getAllowEscaping:[12,1,1,""],getAllowRunning:[12,1,1,""],getBattleScene:[12,1,1,""],getBlock:[12,1,1,""],getBorderDimensions:[12,1,1,""],getBorderHeight:[12,1,1,""],getBorderMetatileId:[12,1,1,""],getBorderWidth:[12,1,1,""],getCollision:[12,1,1,""],getDimensions:[12,1,1,""],getElevation:[12,1,1,""],getFloorNumber:[12,1,1,""],getHeight:[12,1,1,""],getLocation:[12,1,1,""],getMetatileAttributes:[12,1,1,""],getMetatileBehavior:[12,1,1,""],getMetatileEncounterType:[12,1,1,""],getMetatileId:[12,1,1,""],getMetatileLabel:[12,1,1,""],getMetatileLayerOpacity:[12,1,1,""],getMetatileLayerOrder:[12,1,1,""],getMetatileLayerType:[12,1,1,""],getMetatileTerrainType:[12,1,1,""],getMetatileTile:[12,1,1,""],getMetatileTiles:[12,1,1,""],getNumPrimaryTilesetMetatiles:[12,1,1,""],getNumPrimaryTilesetTiles:[12,1,1,""],getNumSecondaryTilesetMetatiles:[12,1,1,""],getNumSecondaryTilesetTiles:[12,1,1,""],getPrimaryTileset:[12,1,1,""],getPrimaryTilesetPalette:[12,1,1,""],getPrimaryTilesetPalettePreview:[12,1,1,""],getPrimaryTilesetPalettes:[12,1,1,""],getPrimaryTilesetPalettesPreview:[12,1,1,""],getRequiresFlash:[12,1,1,""],getSecondaryTileset:[12,1,1,""],getSecondaryTilesetPalette:[12,1,1,""],getSecondaryTilesetPalettePreview:[12,1,1,""],getSecondaryTilesetPalettes:[12,1,1,""],getSecondaryTilesetPalettesPreview:[12,1,1,""],getShowLocationName:[12,1,1,""],getSong:[12,1,1,""],getTilePixels:[12,1,1,""],getType:[12,1,1,""],getWeather:[12,1,1,""],getWidth:[12,1,1,""],magicFill:[12,1,1,""],magicFillFromSelection:[12,1,1,""],redraw:[12,1,1,""],setAllowBiking:[12,1,1,""],setAllowEscaping:[12,1,1,""],setAllowRunning:[12,1,1,""],setBattleScene:[12,1,1,""],setBlock:[12,1,1,"id0"],setBlocksFromSelection:[12,1,1,""],setBorderDimensions:[12,1,1,""],setBorderHeight:[12,1,1,""],setBorderMetatileId:[12,1,1,""],setBorderWidth:[12,1,1,""],setCollision:[12,1,1,""],setDimensions:[12,1,1,""],setElevation:[12,1,1,""],setFloorNumber:[12,1,1,""],setHeight:[12,1,1,""],setLocation:[12,1,1,""],setMetatileAttributes:[12,1,1,""],setMetatileBehavior:[12,1,1,""],setMetatileEncounterType:[12,1,1,""],setMetatileId:[12,1,1,""],setMetatileLabel:[12,1,1,""],setMetatileLayerOpacity:[12,1,1,""],setMetatileLayerOrder:[12,1,1,""],setMetatileLayerType:[12,1,1,""],setMetatileTerrainType:[12,1,1,""],setMetatileTile:[12,1,1,"id1"],setMetatileTiles:[12,1,1,"id2"],setPrimaryTileset:[12,1,1,""],setPrimaryTilesetPalette:[12,1,1,""],setPrimaryTilesetPalettePreview:[12,1,1,""],setPrimaryTilesetPalettes:[12,1,1,""],setPrimaryTilesetPalettesPreview:[12,1,1,""],setRequiresFlash:[12,1,1,""],setSecondaryTileset:[12,1,1,""],setSecondaryTilesetPalette:[12,1,1,""],setSecondaryTilesetPalettePreview:[12,1,1,""],setSecondaryTilesetPalettes:[12,1,1,""],setSecondaryTilesetPalettesPreview:[12,1,1,""],setShowLocationName:[12,1,1,""],setSong:[12,1,1,""],setType:[12,1,1,""],setWeather:[12,1,1,""],setWidth:[12,1,1,""],shift:[12,1,1,""]},overlay:{addImage:[12,1,1,""],addMetatileImage:[12,1,1,""],addPath:[12,1,1,"id18"],addRect:[12,1,1,""],addText:[12,1,1,""],addTileImage:[12,1,1,"id20"],clear:[12,1,1,"id3"],clearClippingRect:[12,1,1,"id15"],createImage:[12,1,1,""],getHorizontalScale:[12,1,1,""],getOpacity:[12,1,1,""],getPosition:[12,1,1,""],getRotation:[12,1,1,""],getVerticalScale:[12,1,1,""],getVisibility:[12,1,1,""],getX:[12,1,1,""],getY:[12,1,1,""],hide:[12,1,1,"id4"],move:[12,1,1,"id17"],rotate:[12,1,1,"id11"],setClippingRect:[12,1,1,"id14"],setHorizontalScale:[12,1,1,"id8"],setOpacity:[12,1,1,"id7"],setPosition:[12,1,1,"id16"],setRotation:[12,1,1,"id10"],setVerticalScale:[12,1,1,"id9"],setVisibility:[12,1,1,"id6"],setX:[12,1,1,"id12"],setY:[12,1,1,"id13"],show:[12,1,1,"id5"]},utility:{error:[12,1,1,""],getBattleSceneNames:[12,1,1,""],getBorderVisibility:[12,1,1,""],getCustomScripts:[12,1,1,""],getGridVisibility:[12,1,1,""],getInputItem:[12,1,1,""],getInputNumber:[12,1,1,""],getInputText:[12,1,1,""],getLocationNames:[12,1,1,""],getMainTab:[12,1,1,""],getMapNames:[12,1,1,""],getMapTypeNames:[12,1,1,""],getMapViewTab:[12,1,1,""],getMetatileBehaviorNames:[12,1,1,""],getPrimaryTilesetNames:[12,1,1,""],getSecondaryTilesetNames:[12,1,1,""],getSmartPathsEnabled:[12,1,1,""],getSongNames:[12,1,1,""],getTilesetNames:[12,1,1,""],getWeatherNames:[12,1,1,""],isPrimaryTileset:[12,1,1,""],isSecondaryTileset:[12,1,1,""],log:[12,1,1,""],registerAction:[12,1,1,""],setBorderVisibility:[12,1,1,""],setGridVisibility:[12,1,1,""],setMainTab:[12,1,1,""],setMapViewTab:[12,1,1,""],setSmartPathsEnabled:[12,1,1,""],setTimeout:[12,1,1,""],showError:[12,1,1,""],showMessage:[12,1,1,""],showQuestion:[12,1,1,""],showWarning:[12,1,1,""],warn:[12,1,1,""]}},objnames:{"0":["js","attribute","JavaScript attribute"],"1":["js","function","JavaScript function"]},objtypes:{"0":"js:attribute","1":"js:function"},terms:{"0e8ccfc4fd3544001f4c25fafd401f7558bdefba":16,"0x10":12,"0x11":12,"0x4":8,"0x8":12,"0x9":12,"2x2":13,"32x20":[],"3x3":6,"4bpp":11,"82abc164dc9f6a74fdf0c535cc1621b7ed05318b":16,"8bpp":11,"8x8":[12,15],"boolean":12,"case":[2,4],"const":12,"default":[4,6,7,9,10,11,12,13,14,16],"export":[12,15,16],"final":[8,12],"function":[4,8,11,16],"goto":4,"import":[2,6,12,13,16],"long":[2,12,16],"new":[0,2,3,4,6,9,10,11,12,13,14,15,16],"pok\u00e9":6,"pok\u00e9cent":4,"pok\u00e9mon":[4,6,9,16],"return":[4,12],"switch":[9,12,15,16],"true":[2,12],"try":[2,12],"var":[4,10],"while":[2,4,6,12,14,16],AND:4,Adding:0,For:[1,2,3,4,5,6,7,9,10,11,12,13,14,15,16],IDs:16,Its:[8,16],NOT:12,One:[7,12],That:8,The:[0,1,2,4,5,6,7,8,9,10,12,13,16],Then:[2,6,7,12],There:[4,8,11,12,13,15],These:[2,3,6,7,12,15],Use:[4,6],Used:[5,15],Useful:12,Will:[],With:[4,12],Yes:12,a0ba1b7c6353f7e4f3066025514c05b323a0123d:16,a1ea3b5e394bc115ba9b86348c161094a00dcca7:16,aarrggbb:12,abil:[2,4,12,16],abl:[2,4,11,12],about:[0,12,16],abov:[2,4,6,8,9,11,12,15,16],accept:7,access:[4,12,13,15,16],accomod:16,accomplish:6,accord:16,accordingli:16,account:[],accur:16,across:15,act:16,action:[0,6,14],actionnam:12,activ:[4,7,12],actual:[4,12,16],ad365a35c1536740cbcbc10bee66e5dd908c39e7:16,adb0a444577b59eb02788c782a3d04bc285be0ba:16,add:[1,3,4,7,10,11,12,13,15,16],added:[12,16],addfilledrect:16,addimag:12,adding:[7,13,16],addit:[5,8,12,15],addition:[4,6,12,16],addmetatileimag:12,addpath:12,addrect:[12,16],addtext:12,addtileimag:12,adher:16,adjac:[4,12],adjust:[6,7,15],adob:15,advanc:[8,16,17],affect:12,after:[2,4,6,8,12,16],again:[4,6],alia:11,all:[2,3,4,6,7,9,11,12,14,15,16],allow:[1,2,4,5,6,7,8,9,12,13,15,16],along:2,alreadi:14,also:[2,4,5,6,7,10,11,12,13,14,15,16],alter:7,altern:[1,4],altogeth:15,alwai:[2,4,16],amount:16,angl:12,ani:[1,2,4,6,9,11,12,13,15,16],anim:[4,12,16],anoth:[4,6,7,9,11],anyth:[4,6],api:[0,16],app:13,appdata:[13,14],appear:[4,6,9,11,12,16],append:[5,10],appli:[12,16],applic:[9,13,14,16],applymov:4,applynighttint:12,appropri:2,arbitrarili:16,area:[2,4,6,8,9,11,12,16],argument:[12,15,16],around:[4,6,9,11,13,16],arrai:[11,12],arriv:4,arrow:[4,16],assign:[4,7,16],associ:[1,2,4,11,15],assum:[12,16],attempt:[15,16],attribut:[12,15,16],auto:16,autocomplet:16,automat:[3,4,5,12,13,15,16],avail:[4,6,7,8,9,11],awai:7,awar:6,axi:6,back:[6,16],background:[0,5,9,12,15],bar:[12,16],base:[0,1,6,7,11,13,16],base_game_vers:[12,13,16],basement:5,basic:[2,6,8,9],batch:12,battl:[4,5,12],battlescen:12,becaus:[2,4,9],becom:16,been:[12,16],befor:[2,6,8,12,16],begin:10,behav:[4,12,16],behavior:[12,16],behind:12,being:[2,8,16],bele:1,belong:5,below:[2,4,6,7,12,16],berri:4,better:16,between:[2,3,4,9,11,12,15,16],beyond:16,bigger:6,bike:[1,5,12],bin:10,binari:[8,11,15],bit:[12,15,16],black:12,blank:[],block:[1,2,12,16],blockdata:[],blue:4,boi:17,border:[0,1,4,10,12,13,16],bordercolor:[12,16],both:[3,6,15,16],bottom:[6,12,15,16],bound:[4,16],boundari:16,box:[4,7,11,12,13,15,16],bread:6,bridg:2,brief:4,briefli:9,bring:[4,6,7,9,11],browser:12,brush:12,bucket:[0,12,14],bucketfil:12,bucketfillfromselect:12,bug:16,build:[4,6,8,12],built:[6,16],bulk:16,bump:16,butter:6,button:[0,3,6,7,8,9,11,12,13,16],bvd:[15,16],c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3:16,c73de8bed752ca538d90cfc93c4a9e8c7965f8c9:16,cach:12,call:[6,12,16],callabl:12,callback:[13,16],can:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],cancel:[12,14],cannot:[1,4,5,14,16],capabl:[0,16],categori:15,caus:[12,16],cave:7,cdae0c1444bed98e652c87dc3e3edcecacfef8b:16,ceil:12,center:[1,4,6,9,16],certain:[4,10,12,15,16],cfg:[6,10,12,13,14,16],chain:6,chanc:7,chang:[0,1,3,4,7,8,9,11,12,13],changelog:0,charact:[4,16],check:[4,6,7,9,12,16],checkbox:[3,6,16],choos:[4,6,7,8,9,12],citi:[3,8],clear:[11,12,16],clearclippingrect:12,clearoverlai:[],click:[1,2,3,4,6,7,8,9,11,12,13,14,16],cliff:2,clip:[12,16],clipboard:16,clockwis:12,clone:[0,13,16],close:[4,12,16],code:[4,12,15],collaps:[9,16],collect:5,collid:12,collis:[0,4,6,8,9,12,13,16],collision_opac:13,color:[12,13,15,16,17],column:2,com:[0,13,16],combin:15,combo:[4,13,16],combobox:[11,16],comma:12,command:[4,13,14,16],comment:16,commit:[12,13,16],commitchang:12,common:2,commonli:2,compat:16,compil:8,complet:12,compos:[],comprehens:[14,16],concept:2,config:[6,10,12,13,16],configur:[0,6,11,12,13,16],conjunct:6,connect:[0,4,6,8,9,12,16],consecut:12,consist:[12,16],constant:[10,11,15,16],constants_event_bg:10,constants_fieldmap:10,constants_flag:10,constants_glob:10,constants_heal_loc:10,constants_item:10,constants_map_group:10,constants_map_typ:10,constants_metatile_behavior:10,constants_metatile_label:10,constants_obj_ev:10,constants_obj_event_mov:10,constants_oppon:10,constants_pokemon:10,constants_region_map_sect:10,constants_secret_bas:10,constants_song:10,constants_trainer_typ:10,constants_var:10,constants_weath:10,contain:[4,9,12,13,15,16],content:12,context:[9,15],contigu:[6,16],continu:[2,6],control:[2,4,5,8],conveni:[4,6,12,15,16],convert:[15,16],coord:12,coordin:[4,11,12,16],coorespond:16,copi:[6,7,16],corner:[3,12],correctli:16,correspond:[11,16],corrupt:16,could:[12,16],count:[2,15,16],counterclockwis:12,coupl:11,cover:[4,9,15],crash:16,creat:[0,4,6,7,9,11,12,13,16],create_map_text_fil:13,createimag:[12,16],creation:6,critic:12,cross:8,crosshair:13,ctrl:[3,4,6,8,9,11,12,14,16],cumbersom:12,current:[2,4,6,7,8,9,11,12,14,15,16],cursor:[4,6,11,13,14,16],custom:[0,1,5,6,11,13,14,16],custom_script:[12,13],cut:16,dai:[7,12],dark:16,data:[6,7,8,10,11,12,13,15,16],data_event_script:10,data_heal_loc:10,data_layouts_fold:10,data_map_fold:10,data_obj_event_gfx:10,data_obj_event_gfx_info:10,data_obj_event_gfx_point:10,data_obj_event_pic_t:10,data_pokemon_gfx:10,data_scripts_fold:10,data_tilesets_fold:10,date:16,daunt:9,deactiv:4,debug:12,decim:12,decompil:[8,16,17],decor:12,default_primary_tileset:13,default_secondary_tileset:13,defin:[6,10,11,12,15,16],degre:12,del:[14,16],delai:12,delaym:12,delet:[0,3,11,14,15,16],deltai:12,deltax:12,demand:12,demonstr:6,denot:2,depend:[1,6,12,13,16],depth:15,describ:[4,7],descript:[4,13],design:6,desir:[3,6,9],despit:16,destin:[3,4],detail:[4,6,9,11,12,16],detailedtext:12,detect:12,determin:[2,4,11,13,15],diagonist:12,dialog:[8,9,12,14,16],did:16,diff:16,differ:[1,2,4,6,9,11,12,15,16],difficulti:8,dig:[5,12],dimens:[6,11,12,16],direct:[2,3,4,6,16],directli:[4,12],directori:12,disabl:[6,7,16],disallow:16,disappear:16,disassembl:17,disk:[7,12],displai:[1,4,6,7,8,11,12,13,15,16],dissect:4,distanc:[4,16],distinguish:11,dive:0,document:[12,16],doe:[4,6,8,12],doesn:[2,6,12,16],doing:8,don:[3,16],done:11,doubl:[3,4,9,11,16],down:[6,7,8,16],download:8,drag:[3,4,6,11,14,16],draw:[4,8,11,12,14,15,16],drawn:[12,16],drop:[7,16],dropdown:[3,6,12,15,16],due:16,dummi:4,duplic:[4,14,16],dure:[2,4,16],dynam:4,each:[2,4,5,6,7,9,10,11,12,15,16],easi:[1,4,6],easier:[6,11,15,16],easiest:3,east:[2,3],ecmascript:12,edg:12,edit:[0,8,9,10,11,13,14,15,16],editor:[0,4,8,12,13,16,17],effect:[15,16],either:[2,6,9,12,15],element:[12,16],elev:[1,2,4,12,13],ellips:16,ellipt:12,els:[2,4],emerg:0,empti:[7,8,16],enabl:[3,6,12,13,16],enable_event_clone_object:13,enable_event_secret_bas:13,enable_event_weather_trigg:13,enable_floor_numb:13,enable_heal_location_respawn_data:13,enable_hidden_item_quant:13,enable_hidden_item_requires_itemfind:13,enable_object_event_in_connect:[],enable_triple_layer_metatil:[12,13],enclos:12,encount:[0,12,13,16],encountertyp:12,end:[10,16],endless:12,enforc:7,engin:[4,5,13],enhanc:12,ensur:4,enter:[1,2,4,5,9,11,12,14],entir:[6,11,12,15,16],entranc:4,entri:[0,12,16],equal:4,equival:8,eras:12,error:[12,16],escap:[1,5,12],essenti:12,etc:16,evalu:16,even:[6,12,14],event:[0,1,3,8,9,12,13,14,16],event_bg:10,event_object:10,event_object_mov:10,event_script:10,everi:[6,11,12,15],exactli:6,exampl:[1,2,3,4,5,6,10,11,12,15,16],except:[2,4],exchang:11,exclus:[4,5,15],execut:[4,12,13],exist:[1,4,6,8,11,12,16],exit:[12,16],expand:[5,9,16],expect:10,expens:12,explain:4,explan:11,explanatori:5,explicitli:16,explor:2,express:16,extend:[4,16],extens:[4,12,16],extra:16,extrem:3,eyedropp:[6,14,15],face:[4,15,16],fake:12,fall:16,fals:12,familiar:8,fan:16,featur:[2,3,8,9,11,16],feel:0,few:[4,6,8,9],fewer:[],field:[0,4,5,6,11,13,16],fieldmap:10,file:[0,3,4,6,8,9,11,12,13,15,16],filepath:[10,11,12,13],fill:[0,2,12,13,14,16],fillcolor:[12,16],filter:[9,16],find:[0,10],finish:[2,11],first:[2,4,6,7,8,9,11,12,13,16],fit:16,fix:6,flag:[4,10,16],flash:[5,12],flip:[11,12,16],floor:[1,5,12,13,16],floornumb:12,flow:[2,6],flower:8,floweri:8,fly:[1,4],focu:16,folder:[1,8,9,16],follow:[0,6,8,12],font:12,forc:[12,13],forceredraw:12,fork:12,form:[12,15],format:[6,11,12,15,16,17],found:[4,8,10,15,16],four:7,frame:16,frlg:16,from:[1,2,4,6,7,8,9,10,11,12,14,16,17],front:[4,16],full:[12,16],fullest:9,func:12,functionnam:12,futur:[],game:[2,4,5,6,7,8,9,11,12,16,17],gameplai:[2,4,9],gba:[13,15],gen:[8,17],gener:[2,8,10,12,14,15],get:[0,6,12],getallowbik:12,getallowescap:12,getallowrun:12,getbasegamevers:[],getbattlescen:12,getbattlescenenam:12,getblock:12,getborderdimens:12,getborderheight:12,getbordermetatileid:12,getbordervis:12,getborderwidth:12,getcollis:12,getcustomscript:12,getdimens:12,getelev:12,getfloornumb:12,getgridvis:12,getheight:12,gethorizontalscal:12,geti:12,getinputitem:12,getinputnumb:12,getinputtext:12,getloc:12,getlocationnam:12,getmaintab:12,getmapnam:12,getmaptypenam:12,getmapviewtab:12,getmaxprimarytilesetmetatil:[],getmaxprimarytilesettil:[],getmaxsecondarytilesetmetatil:[],getmaxsecondarytilesettil:[],getmetatileattribut:12,getmetatilebehavior:12,getmetatilebehaviornam:12,getmetatileencountertyp:12,getmetatileid:12,getmetatilelabel:12,getmetatilelayeropac:12,getmetatilelayerord:12,getmetatilelayertyp:12,getmetatileterraintyp:12,getmetatiletil:12,getnummetatilelay:[],getnumprimarytilesetmetatil:12,getnumprimarytilesettil:12,getnumsecondarytilesetmetatil:12,getnumsecondarytilesettil:12,getnumtilesinmetatil:[],getopac:12,getoverlayi:[],getoverlayopac:[],getoverlayposit:[],getoverlayvis:[],getoverlayx:[],getporymapvers:[],getposit:12,getprimarytileset:12,getprimarytilesetnam:12,getprimarytilesetpalett:12,getprimarytilesetpalettepreview:12,getprimarytilesetpalettespreview:12,getrequiresflash:12,getrot:12,getsecondarytileset:12,getsecondarytilesetnam:12,getsecondarytilesetpalett:12,getsecondarytilesetpalettepreview:12,getsecondarytilesetpalettespreview:12,getshowlocationnam:12,getsmartpathsen:12,getsong:12,getsongnam:12,gettilepixel:12,gettilesetnam:12,gettyp:12,getverticalscal:12,getvis:12,getweath:12,getweathernam:12,getwidth:12,getx:12,gif:[6,16],ginitialmovementtypefacingdirect:10,git:[4,8],github:[0,13,16],gitignor:13,give:[4,6,7,9,16],given:[7,12,15,16],global:[4,10,12,13],gmonicont:10,goe:12,going:[4,14],good:[10,12],gpl:16,graphic:[4,5,10,16],graphics_file_rul:15,grass:[2,8,12,15],grasstil:12,great:8,green:[4,7],greet:8,grid:[6,12,14,16],group:[0,1,6,9,13,14,16],grow:16,gtileset_gener:13,gtileset_pallettown:13,gtileset_petalburg:13,guarante:[12,16],hack:[8,15],half:2,handl:16,happen:[4,12,16],hardcod:[4,16],hardwar:15,has:[2,3,4,5,9,11,14,15,16],have:[2,3,4,6,7,8,9,11,12,13,14,15,16],head:11,headbutt_mon:7,header:[0,9,10,13,16],heal:[0,1,13,16],heal_loc:[4,10],heal_location_:16,healspot:0,height:[1,11,12,16],help:[6,15,16],here:[2,12,14,15],hex:[15,16],hexadecim:2,hidden:[0,6,12,13,16],hide:[1,5,12,16],hideoverlai:[],hierarch:9,high:17,higher:12,highli:8,highlight:16,higlight:11,histori:[2,12,14,16],hit:16,hold:[4,6,14,16],home:16,hop:2,horizont:[3,12,16],hous:16,hover:[6,13,16],how:[2,4,6,8,9,12,16],howev:[4,6,12],hscale:[12,16],html:12,http:[0,13,16],huderlem:[0,16],huge:16,ice:15,icon:[6,10,12,16],idea:10,ident:[2,6],ids:[12,13],ignor:[8,16],illustr:[2,6],imag:[0,4,6,10,12,16],immedi:16,impass:[2,12],implement:7,implicitli:12,improperli:16,improv:8,inanim:16,inc:[4,10,13,16],includ:[2,4,6,7,9,10,11,15,16],inclus:12,incompat:6,incorrect:16,increment:12,independ:16,index:[7,12,15,16],indexof:12,indic:[6,12,15,16],individu:[6,12,15,16],indoor:1,info:12,inform:[12,16],informativetext:12,inherit:4,initi:[12,16],initial_facing_t:10,input:[12,16],insert:12,insid:[4,12],instal:8,instanc:11,instead:[4,12,16],integ:[11,16],integr:[10,16],interact:[2,4,9,12,16],interchang:16,interest:12,interpret:16,interv:12,introduc:16,introduct:0,invalid:16,invis:[4,12],involv:4,iscompress:13,isprimarytileset:12,issecondarytileset:12,issu:16,item:[0,5,10,12,13,16],itemfind:[4,13],iter:16,its:[4,6,16],itself:12,jasc:[15,16],javascript:[12,16],json:[6,7,10,11,13,16],json_layout:10,json_map_group:10,json_region_map_entri:10,json_region_porymap_cfg:10,json_wild_encount:10,jump:16,junk:16,just:[1,2,6,7,15],kanto:16,keep:[3,5,13,16],kei:[6,14,16],keyboard:[11,12,14,16],keyword:12,known:4,label:[10,11,12,13,16],laid:6,land:[2,12],languag:17,larg:[6,16],larger:[6,9],last:[12,16],later:12,launch:[8,12,13,16],layer:[12,13,16],layers_per_metatil:12,layertyp:12,layout:[0,1,9,10,16],layouts_t:16,learn:[6,8,9],leav:2,left:[2,4,6,8,9,11,12,14,15,16],length:12,let:[2,4,6,7,8,9,11,12,17],letter:12,level:[2,7,10,16,17],librari:[13,14],life:[4,6],like:[2,4,6,9,12,15,16],limit:[5,12,15,16],line:[4,6,16],link:[],linux:[8,16],list:[0,1,4,6,10,11,12,13,14,16],listen:17,littl:4,load:[4,8,9,12,13,16],local:4,locat:[0,1,5,6,8,10,11,12,13,16],lock:[4,6,16],log:[12,16],logic:12,longer:[4,16],look:[0,4,8,9,11],lose:16,lot:15,lower:[12,16],mac:[8,16],maco:[13,14,16],macro:15,made:[7,16],magic:[12,14,16],magicfil:12,magicfillfromselect:12,mai:[1,4,7,13,15,16],main:[0,6,7,8,11,12,16],main_splitter_st:13,maintain:[2,10],major:[12,16],make:[2,4,6,8,11,12,15,16],makefil:15,mani:[4,8,9,11,12,14,16],manipul:[7,12],manual:[0,12,13],map:[0,7,8,10,13,16,17],map_dynam:16,map_group:10,map_groups_count:16,map_non:16,map_sort_ord:13,map_splitter_st:13,map_typ:10,map_type_indoor:5,mapjson:16,mapnam:12,mapsec_new_mapsec:[],mapsec_non:11,mark:4,mart:6,match:[4,6,16],math:12,max:[10,12,16],max_primary_metatil:12,max_primary_til:12,max_secondary_metatil:12,max_secondary_til:12,maximum:[7,12,16],mean:[2,3,4,12],meant:17,measur:[4,16],memori:12,menu:[0,3,7,12,13,16],messag:[12,16],metatil:[0,1,2,4,8,9,10,12,13,14,16],metatile_behavior:[10,15],metatile_id:15,metatile_label:[10,15,16],metatileid:12,metatiles_zoom:13,method:[6,16],middl:[6,12,14,15,16],might:[7,12],millisecond:12,mimic:16,min:[10,12,16],minimum:[7,12,16],minor:[12,16],mirror:0,miscellan:[5,12],miss:[0,16],mistak:[6,11],mode:[1,9,14,16],modif:2,modifi:[6,9,11,12,15,16],monitor:[13,16],monitor_fil:13,more:[4,6,8,9,11,12,14,15,16],most:[2,8,9,11,13,16],mostli:5,mountain:[2,6],mous:[4,6,11,12,16],mouseov:16,move:[2,3,4,5,12,14,16],movement:[4,16],moveoverlai:[],much:8,multi:[2,16],multilin:16,multipl:[4,6,7,11,12,14,16],music:[5,9,16,17],must:[3,4,6,7,8,12,15],my_script:12,name:[1,4,5,6,7,9,10,11,12,15,16],navig:[0,3,4,7,8,11,16],nearli:2,need:[2,3,4,5,6,11,15,16],neg:[5,11,12,16],never:4,new_map_border_metatil:13,new_map_elev:13,new_map_metatil:13,newblock:12,newheight:12,newli:[12,16],newmetatileid:12,newtab:12,newwidth:12,next:[2,4,7,8,9,12,13,16],nice:12,night:12,nodej:12,nodep:8,non:[4,11],none:12,normal:[4,6,12,15],north:2,notabl:[8,16],note:[5,10,12],noth:[4,12,16],notic:[11,16],now:[2,6,7,8,12,16],npc:[4,13],num_til:15,number:[1,2,4,5,7,12,13,16],object:[0,2,6,9,12,13,16],object_ev:10,object_event_graph:10,object_event_graphics_info:[10,16],object_event_graphics_info_point:10,object_event_pic_t:10,object_event_templates_count:10,occur:[12,16],odd:12,off:[2,6,12,16],offici:16,offset:[3,11,16],old:[14,16],oldheight:12,oldtab:12,oldwidth:12,onblockchang:[12,16],onblockhoverchang:12,onblockhoverclear:12,onbordermetatilechang:12,onborderres:12,onbordervisibilitytoggl:12,onc:[4,6,12,16],one:[2,3,6,7,9,11,12,16],ones:16,onli:[2,3,4,6,7,9,10,12,15,16],onmaintabchang:12,onmapopen:12,onmapres:12,onmapshift:12,onmapviewtabchang:12,onprojectclos:12,onprojectopen:12,ontilesetupd:12,onto:[2,6,9,11,12],opac:[12,13,16],opaqu:12,open:[0,3,6,7,8,9,11,12,13,14,15,16],oper:[9,12,15,16],oppon:10,optim:6,option:[0,4,9,10,11,12,13,14,15,16],order:[1,4,7,12,13,16],organ:9,origin:[4,12,16],other:[4,6,9,11,12,13,16,17],otherwis:[7,10,12],our:[7,8,12],out:[0,4,6,7,9,11,12,14,16],outdoor:1,outlin:[6,12,14,16],output:15,outsid:[12,16],over:[2,4,5,6,9,16],overhaul:16,overlai:[13,16],overload:12,overrid:10,overridden:10,overview:12,overworld:4,overwrit:[12,14],overwritten:12,own:12,paint:[0,6,8,9,11,12,14,16],pair:12,pal:[11,15,16],palett:[0,10,11,12,16],paletteid:12,paletteindex:12,pane:[6,9,11,15,16],panel:[8,15,16],pars:16,part:9,partial:[6,16],particular:2,particularli:4,passabl:12,past:16,patch:12,path:[0,2,10,11,12,14,16],pathwai:6,patient:9,pattern:[6,12],pencil:[0,4,8,14,16],per:[14,16],percent:12,perform:[6,12,16],perman:12,persist:16,petalburg:[3,8],pick:[4,15],picker:[6,16],pictur:[7,15,16],pink:4,pixel:[12,15,16],place:[4,6,8,11,12,16],placehold:16,plai:5,plain:[11,16],plain_grass:15,platform:[8,13,16],player:[1,2,3,4,6,9,11,14,15,16],pleas:0,plu:[3,4],png:[15,16],pointer:[0,4,14,16],pokecryst:17,pokeemerald:[4,6,8,10,11,12,13,16],pokefir:[4,5,6,8,11,12,13,15,16],pokemon:[1,7,9,10,12,16],pokemon_icon:10,pokemon_icon_t:10,poker:17,pokerubi:[4,6,8,10,12,16],polish:17,pond:6,pop:8,popul:[7,11,12,15],popular:17,popup:[1,5,11],pori:[4,10,13,16],port:16,portion:6,porycript:4,porymap:[1,3,4,6,7,9,10,11,12,14,15,16],porymap_config:10,poryscript:[16,17],posit:[0,6,11,12,16],possibl:[7,12,16],power:[6,12],pre:[6,16],prefab:[0,12,13,16],prefabr:6,prefabs_filepath:[6,13],prefabs_import_prompt:13,prefer:[4,14,16],prefix:[5,12,16],present:[],preserv:16,press:[3,4,6,8,9,16],pret:[8,13,14,16],pretti:7,pretty_cursor:13,prevblock:12,prevent:16,preview:[6,12],previou:[2,16],previous:[12,16],prevmetatileid:12,primari:[1,6,8,10,12,13,15,16],pro:15,probabl:[10,12],procedur:12,process:[2,4],program:17,project:[0,1,4,5,6,8,9,11,12,13,14,15,16],project_root:[6,13],projectpath:12,prompt:[6,13,14,16],proper:16,properli:16,properti:[0,2,4,5,8,9,11,12,16],provid:[4,6,7,8,12,15,16],pull:16,purpos:[2,9],qt6:16,quantiti:[4,13],question:12,quick:6,quickli:9,radiu:[4,6,13],rais:16,randint:12,random:12,rang:[4,12],rate:7,rather:[6,12,16],ratio:7,raw:12,rawvalu:12,reach:0,reactiv:16,read:[4,8,10,11,12,13,16],realist:15,reason:[7,15],receiv:4,recent:[13,16],recent_map:13,recent_project:13,recommend:8,rectangl:[6,12,13,16],rectangular:12,red:[2,7,16],redo:[0,2,4,8,11,14,16],redraw:12,reduc:16,refer:[0,14],referenc:15,refresh:12,region:[0,1,5,6,8,12,16],region_map:[10,11],region_map_dimens:[],region_map_entri:[],region_map_sect:[10,11],regist:0,registeract:12,registri:16,regress:16,regular:6,rejoic:16,rel:[11,12],relat:[0,10,12],releas:[6,8,16],reli:10,reload:[12,16],remain:12,rememb:[2,12,16],remov:[15,16],renam:[10,16],render:[12,16],reopen_on_launch:13,reorder:16,replac:[11,16],repo:[13,16],report:16,repres:[2,7,12],requir:[4,5,12,13,16],reselect:16,reset:[11,14,16],resili:16,resiz:[6,16],resolut:16,respawn:[4,13],respect:[8,16],respond:16,rest:12,restor:[13,14,16],restrict:11,result:8,retriev:12,rgb:[12,16],right:[1,2,3,4,6,7,9,11,12,14,15,16],rival:4,rme:11,rom:8,rooftop:5,root:[11,13],rope:[1,5,12],rotat:[12,16],round:[12,16],rout:[2,3],row:[2,16],rrggbb:12,rubi:5,rule:[12,15],ruler:[0,16],run:[1,5,12],same:[2,4,6,8,12,14,16],save:[3,6,7,8,12,14,15,16],scale:[12,13,14,16],scenario:[15,16],scene:[5,12],scratch:[11,15],screen:[7,8,13,15,16],script:[0,9,10,13,16,17],scroll:6,seamlessli:3,second:[2,8,9,13],secondari:[1,6,10,12,13,15,16],secret:[0,13,16],secret_bas:[4,10],section:[1,4,5,6,9,11],see:[1,4,6,7,8,9,12,13,16],seem:9,seen:16,select:[0,3,4,7,8,9,11,12,14,15,16],selector:[2,6,11,16],self:5,semant:16,sensibl:16,separ:12,session:16,set:[0,4,6,7,9,11,14,15,16],setallowbik:12,setallowescap:12,setallowrun:12,setbattlescen:12,setblock:12,setblocksfromselect:12,setborderdimens:12,setborderheight:12,setbordermetatileid:12,setbordervis:12,setborderwidth:12,setclippingrect:12,setcollis:12,setdimens:12,setelev:12,setfloornumb:12,setgridvis:12,setheight:12,sethorizontalscal:12,seti:12,setloc:12,setmaintab:12,setmapviewtab:12,setmetatileattribut:12,setmetatilebehavior:12,setmetatileencountertyp:12,setmetatileid:12,setmetatilelabel:12,setmetatilelayeropac:12,setmetatilelayerord:12,setmetatilelayertyp:12,setmetatileterraintyp:12,setmetatiletil:12,setopac:12,setoverlayi:[],setoverlayopac:[],setoverlayposit:[],setoverlaysi:[],setoverlaysopac:[],setoverlaysposit:[],setoverlaysvis:[],setoverlaysx:[],setoverlayvis:[],setoverlayx:[],setposit:12,setprimarytileset:12,setprimarytilesetpalett:12,setprimarytilesetpalettepreview:12,setprimarytilesetpalettespreview:12,setrequiresflash:12,setrot:12,setsecondarytileset:12,setsecondarytilesetpalett:12,setsecondarytilesetpalettepreview:12,setsecondarytilesetpalettespreview:12,setshowlocationnam:12,setsmartpathsen:12,setsong:12,settimeout:12,settranspar:12,settyp:12,setup:8,setverticalscal:12,setvis:12,setweath:12,setwhiteoutrespawnwarpandhealernpc:4,setwidth:12,setx:12,sever:[7,12,13,15],shape:12,share:16,shift:[0,3,4,12,14,16],shoe:5,shortcut:[0,2,6,8,11,12,16],should:[2,4,6,7,8,10,11,12,13,16],shouldn:8,show:[1,5,6,8,9,12,14,15,16],show_cursor_til:13,show_player_view:13,showerror:12,showmessag:12,shown:12,showoverlai:[],showquest:12,showwarn:12,shrink:16,side:[2,3,6,8,9,15],sight:4,sign:[0,16],signific:16,signpost:[2,4],silenc:16,similar:[2,3,7],simpl:[4,7],simpli:[3,4,6,9,11,15],simplifi:6,simultan:11,sinc:[3,8,12,15,16],singl:[7,9,11,12],situat:[9,16],size:[6,11,12,13,16],slider:[2,6,11,15,16],slot:7,slow:12,small:4,smaller:12,smart:[0,2,12,14,16],smooth:16,snap:6,some:[1,2,4,6,8,9,12,13,16],someth:[0,2,4,7,11],sometim:16,somewhat:16,song:[5,10,12],sort:[1,9,13,16],sourc:[8,15],south:2,space:16,span:11,spawn_:16,speci:7,special:[2,4],specif:[4,13,16],specifi:[4,12,16],specifieid:12,specifii:12,spinbox:11,spinner:[4,12,15,16],split:15,spot:4,sprint:1,sprite:[4,10,16],squar:[4,11,16],src:[4,10,11],ssecretbaseentrancemetatil:4,stai:16,stair:2,stand:[4,15],standard:4,start:[0,2,6,12],startup:16,state:12,statu:16,step:12,still:16,stitch:16,stop:12,store:[11,13,14,16],straight:[0,12,14,16],straightforward:7,strict:[],string:[11,12,16],struct:16,studio:17,stuff:10,successfulli:[8,12],suffici:[11,12],summar:9,support:[5,6,8,11,12,13,14,16],sure:[2,3,8],surf:2,surround:[6,9],swap:11,symbol:16,sync:[3,16],system:16,tab:[0,2,3,4,6,7,9,12,16],tabl:[10,12,13,15,16],tag:12,take:[6,7,8,9,11,12,16],taken:16,tall:15,target:[4,12],technic:[4,12],templat:16,temporarili:[6,16],terrain:12,terraintyp:12,test:12,text:[2,4,9,12,13,16],text_editor_goto_lin:13,text_editor_open_directori:13,than:[6,12,16],thei:[1,3,4,5,6,9,12,14,15,16],them:[2,3,4,5,6,7,12,16],theme:[13,16],therefor:[7,8],thi:[1,2,3,4,5,6,7,9,10,11,12,13,15,16],thing:[4,5,6,7,8,9],think:[6,8],those:[6,8,12],though:[6,16],three:[4,11],through:[2,3,16],tied:[],tile:[0,2,4,8,9,10,11,12,16],tileend:12,tileid:12,tileindex:12,tilemap:[11,16,17],tiles_per_metatil:12,tileset:[0,1,8,10,11,13,16],tilesetnam:12,tilesets_graph:10,tilesets_graphics_asm:10,tilesets_have_callback:13,tilesets_have_is_compress:13,tilesets_head:10,tilesets_headers_asm:10,tilesets_metatil:10,tilesets_metatiles_asm:10,tilestart:12,time:[2,4,6,7,8,9,12,13,15,16],timelaps:16,tint:12,titl:12,togeth:[3,4,6,12,14,15],toggl:[6,12,13,14,16],toggld:16,too:[2,16],tool:[0,1,2,8,11,12,16],toolbar:[6,8],toolbutton:[14,15],top:[2,3,4,11,12,15,16],total:[2,7],tpl:16,track:13,tradit:8,trainer:[4,10,16],trainer_sight_or_berry_tree_id:16,trainer_typ:[10,16],trainer_type_norm:4,transform:12,transit:[2,4],transpar:[2,12,16],treat:16,tree:[4,6,16],trigger:[0,9,12,13],tripl:[13,16],turn:16,two:[3,6,9,11,15],type:[0,1,4,5,9,11,12,16],typic:[2,4],ubuntu:16,unabl:2,unavail:4,uncheck:11,uncommit:12,under:[2,11],underli:[12,16],underlin:12,underscor:12,undertand:2,underw:16,undo:[0,2,4,8,11,12,14,16],undoabl:16,unexpect:16,unfortun:4,unhappi:11,uniq:7,uniqu:[4,11],unknown:16,unless:[10,12],unlik:2,unlock:4,unnecessari:16,unreleas:0,unsav:16,until:7,unus:[15,16],updat:[2,3,6,12,16],upstream:16,usabl:8,usag:15,use:[1,2,4,6,7,8,9,11,12,13,14,15,16],use_custom_border_s:[6,12,13,16],use_encounter_json:13,use_poryscript:[13,16],usecach:12,used:[2,3,4,5,6,9,12,13,14,15,16,17],useful:[3,4,5,6,12,15,16],user:[0,1,2,6,8,10,11,12,13,15,16],uses:[2,4,6,7,12,13,15,16],using:[4,6,8,12,14,16],usual:12,util:16,valid:[11,16],valu:[3,4,5,6,11,12,15,16],vanilla:7,var_valu:16,variabl:[4,13],varieti:15,variou:[5,6,8,9,16],veri:[2,3,4,6,12],version:[2,4,5,6,8,12,16],vertic:[3,12,16],via:[6,12,13,16],video:17,view:[2,3,4,5,6,9,11,12,14,16],visibl:[4,6,12,16],vision:5,visual:[0,2,16],vscale:[12,16],wai:[3,4,6,12],wait:12,walk:[2,3,4,9],want:[7,10,11,12,13],warn:[12,16],warp:[0,9,15,16],wasn:16,watch:16,water:[12,15],waterfal:12,weather:[0,5,9,10,12,13],web:12,websit:16,were:[4,6,16],weren:16,west:[2,3],what:[0,2,4,5,6,9,11],wheel:6,when:[1,2,3,4,5,6,8,9,11,12,13,15,16],whenev:[2,6,12,15],where:[4,6,11,12,15,16],whether:[1,2,5,12,13,15,16],which:[1,2,3,5,6,7,9,11,12,15,16],whichev:6,white:[2,4,6],whose:16,why:2,widget:[13,16],width:[1,11,12,16],wiki:13,wild:[0,9,12,13,15,16],wild_encount:10,window:[0,1,4,5,6,7,8,11,12,13,15,16],window_geometri:13,window_st:13,within:[4,9,14,15],without:[6,11,12,16],woman:4,won:[2,12],word:12,work:[6,8,9,15,16],workflow:[6,8,12],would:[2,10,12,16],wouldn:16,wrap:6,write:[0,8,10,16],written:16,wsl:16,xcoord:12,xdelta:12,xflip:[12,16],xoffset:[12,16],ycoord:12,ydelta:12,yes:[10,13],yet:[12,16],yflip:[12,16],yoffset:[12,16],you:[0,1,2,3,4,5,6,7,8,9,10,11,13,14,15,16,17],your:[1,3,4,5,6,7,8,9,10,11,13,14],yourself:[10,14],zoom:[6,11,14,16]},titles:["Porymap Documentation","Creating New Maps","Editing Map Collisions","Editing Map Connections","Editing Map Events","Editing Map Headers","Editing Map Tiles","Editing Wild Encounters","Introduction","Navigation","Project Files","The Region Map Editor","Scripting Capabilities","Porymap Settings","Shortcuts","The Tileset Editor","Changelog","Related Projects"],titleterms:{"break":16,"function":12,"import":15,"new":[1,7],Added:16,Adding:[4,7],The:[11,15],about:8,action:12,advanc:15,api:12,background:11,base:4,behavior:15,border:6,bucket:6,button:4,callback:12,capabl:12,chang:[6,15,16],changelog:16,citi:[],clone:4,collis:2,configur:7,connect:3,constant:12,creat:1,custom:12,delet:4,dive:3,document:0,edit:[2,3,4,5,6,7,12],editor:[9,11,14,15],emerg:3,encount:[7,15],entri:11,event:4,field:7,file:10,fill:6,fix:16,follow:3,from:15,get:8,group:7,header:[5,12],heal:4,healspot:4,hidden:4,imag:[11,15],introduct:8,item:4,label:15,layer:15,layout:11,list:9,locat:4,main:[9,14],map:[1,2,3,4,5,6,9,11,12,14,15],menu:15,metatil:[6,15],mirror:3,navig:9,number:15,object:4,open:4,option:[1,6],other:15,overlai:12,paint:2,palett:15,path:6,pencil:6,pointer:6,porymap:[0,8,13],posit:4,prefab:6,project:[10,17],properti:15,redo:6,region:[9,11,14],regist:12,relat:17,ruler:4,script:[4,12],secret:4,select:[2,6],set:[12,13],shift:6,shortcut:14,sign:4,smart:6,start:8,straight:6,tab:11,terrain:15,tile:[6,15],tileset:[6,9,12,14,15],tool:[4,6,15],trigger:4,type:[2,15],undo:6,unreleas:16,util:12,visual:6,warp:[3,4],weather:4,wild:7,window:[9,14],write:12}}) \ No newline at end of file diff --git a/forms/aboutporymap.ui b/forms/aboutporymap.ui index 4ace2b86..150d86b7 100644 --- a/forms/aboutporymap.ui +++ b/forms/aboutporymap.ui @@ -53,7 +53,7 @@ - Version 4.5.0 - December 26th, 2021 + Version 5.0.0 - October 30th, 2022 Qt::AlignCenter @@ -103,16 +103,77 @@ p, li { white-space: pre-wrap; } </style></head><body style=" font-family:'MS Shell Dlg 2'; font-size:8.25pt; font-weight:400; font-style:normal;"> <p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><span style=" font-size:8pt;">This version of porymap is compatible with pokeemerald, pokefirered, and pokeruby as of the following commit hashes:</span></p> -<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><span style=" font-size:8pt;">pokeemerald: cb5b8da77b9ba6837fcc8c5163bedc5008b12c2c</span></p> -<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><span style=" font-size:8pt;">pokefirered: ece62fa4ba8e385809deff330c7d7a0b348c10ae</span></p> -<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><span style=" font-size:8pt;">pokeruby: f302fcc134bf354c3655e3423be68fd7a99cb396</span></p> +<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><span style=" font-size:8pt;">pokeemerald: c76beed98990a57c84d3930190fd194abfedf7e8</span></p> +<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><span style=" font-size:8pt;">pokefirered: 52591dcee42933d64f60c59276fc13c3bb89c47b</span></p> +<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><span style=" font-size:8pt;">pokeruby: d99cb43736dd1d4ee4820f838cb259d773d8bf25</span></p> <p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><span style=" font-size:8pt;">Please report any issues on GitHub: </span><a href="https://github.com/huderlem/porymap/issues"><span style=" font-size:8pt; text-decoration: underline; color:#0000ff;">https://github.com/huderlem/porymap/issues</span></a></p> <hr /> <h1 style=" margin-top:18px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><a name="changelog"></a><span style=" font-size:xx-large; font-weight:600;">C</span><span style=" font-size:xx-large; font-weight:600;">hangelog</span></h1> <p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">All notable changes to this project will be documented in this file.</p> <p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">The format is based on <a href="https://keepachangelog.com/en/1.0.0/"><span style=" text-decoration: underline; color:#0000ff;">Keep a Changelog</span></a>,and this project somewhat adheres to <a href="https://semver.org/spec/v2.0.0.html"><span style=" text-decoration: underline; color:#0000ff;">Semantic Versioning</span></a>. The MAJOR version number is bumped when there are breaking changes in the pret projects.</p> -<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">The <span style=" font-weight:600;">&quot;Breaking Changes&quot;</span> 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> -<h2 style=" margin-top:16px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><a name="-4-5-0-2021-12-26"></a><a href="https://github.com/huderlem/porymap/compare/4.4.0...4.4.0"><span style=" font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;">4</span></a><span style=" font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;">.5.0</span><span style=" font-size:x-large; font-weight:600;"> - 2021-12-26</span></h2> +<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">The <span style=" font-weight:600;">&quot;Breaking Changes&quot;</span> listed below are changes that have been made in the decompilation projects (e.g. pokeemerald), which porymap requires in order to work properly. It also includes changes to the scripting API that may change the behavior of existing porymap scripts. If porymap is used with a project or API script that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.</p> +<h2 style=" margin-top:16px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><a name="-unreleased-"></a><a href="https://github.com/huderlem/porymap/compare/5.0.0...HEAD"><span style=" font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;">U</span></a><span style=" font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;">nreleased</span></h2> +<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Nothing, yet.</p> +<h2 style=" margin-top:16px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><a name="-5-0-0-2022-10-30"></a><a href="https://github.com/huderlem/porymap/compare/4.5.0...5.0.0"><span style=" font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;">5</span></a><span style=" font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;">.0.0</span><span style=" font-size:x-large; font-weight:600;"> - 2022-10-30</span></h2> +<h3 style=" margin-top:14px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><a name="breaking-changes"></a><span style=" font-size:large; font-weight:600;">B</span><span style=" font-size:large; font-weight:600;">reaking Changes</span></h3> +<ul style="margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;"><li style="" style=" margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Proper support for pokefirered's clone objects was added, which requires the changes made in <a href="https://github.com/pret/pokefirered/pull/484"><span style=" text-decoration: underline; color:#0000ff;">pokefirered/#484</span></a>.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Warp IDs are now treated as strings, which requires the change to <span style=" font-family:'Courier New';">mapjson</span> made in <a href="https://github.com/pret/pokeemerald/pull/1755"><span style=" text-decoration: underline; color:#0000ff;">pokeemerald/#1755</span></a>. Additionally <span style=" font-family:'Courier New';">MAP_NONE</span> was renamed to <span style=" font-family:'Courier New';">MAP_DYNAMIC</span>. Both changes also apply to pokefirered and pokeruby.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Many API functions which were previously accessible via the <span style=" font-family:'Courier New';">map</span> object are now accessible via one of the new objects <span style=" font-family:'Courier New';">overlay</span>, <span style=" font-family:'Courier New';">utility</span>, or <span style=" font-family:'Courier New';">constants</span>. Some functions were renamed accordingly. See <a href="https://github.com/huderlem/porymap/pull/460"><span style=" text-decoration: underline; color:#0000ff;">porymap/#460</span></a> for a full list of API function name changes.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Arguments for the API function <span style=" font-family:'Courier New';">createImage</span> have changed: <span style=" font-family:'Courier New';">xflip</span> and <span style=" font-family:'Courier New';">yflip</span> have been replaced with <span style=" font-family:'Courier New';">hScale</span> and <span style=" font-family:'Courier New';">vScale</span>, and <span style=" font-family:'Courier New';">offset</span> has been replaced with <span style=" font-family:'Courier New';">xOffset</span> and <span style=" font-family:'Courier New';">yOffset</span>.</li> +<li style="" style=" margin-top:0px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">The API function <span style=" font-family:'Courier New';">addFilledRect</span> has been removed; it's been replaced by new arguments in <span style=" font-family:'Courier New';">addRect</span>: <span style=" font-family:'Courier New';">color</span> has been replaced with <span style=" font-family:'Courier New';">borderColor</span> and <span style=" font-family:'Courier New';">fillColor</span>, and a new <span style=" font-family:'Courier New';">rounding</span> argument allows ellipses to be drawn.</li></ul> +<h3 style=" margin-top:14px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><a name="added"></a><span style=" font-size:large; font-weight:600;">A</span><span style=" font-size:large; font-weight:600;">dded</span></h3> +<ul style="margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;"><li style="" style=" margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Add prefab support</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Add Cut/Copy/Paste for metatiles in the Tileset Editor.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Add button to copy the full metatile label to the clipboard in the Tileset Editor.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Add ability to export an image of the primary or secondary tileset's metatiles.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Add new config options for customizing how new maps are filled, setting default tilesets, and whether the most recent project should be opened on launch.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Add color picker to palette editor for taking colors from the screen.</li> +<li style="" style=" margin-top:0px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Add new features to the scripting API, including the ability to display messages and user input windows, set the overlay's opacity, rotation, scale, and clipping, interact with map header properties and the map border, read tile pixel data, and more.</li></ul> +<h3 style=" margin-top:14px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><a name="changed"></a><span style=" font-size:large; font-weight:600;">C</span><span style=" font-size:large; font-weight:600;">hanged</span></h3> +<ul style="margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;"><li style="" style=" margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Overhauled the region map editor, adding support for tilemaps, and significant customization. Also now supports pokefirered.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Previous settings will be remembered in the New Map Options window.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">The Custom Attributes table for map headers and events now supports types other than strings.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">If an object event is inanimate, it will always render using its first frame.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Unused metatile attribute bits are preserved instead of being cleared.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">The wild encounter editor is automatically disabled if the encounter JSON data cannot be read</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Metatiles are always rendered accurately with 3 layers, and the unused layer is not assumed to be transparent.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><span style=" font-family:'Courier New';">object_event_graphics_info.h</span> can now be parsed correctly if it uses structs with attributes.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Tileset data in <span style=" font-family:'Courier New';">headers</span>, <span style=" font-family:'Courier New';">graphics</span>, and <span style=" font-family:'Courier New';">metatiles</span> can now be parsed if written in C.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">The amount of time it takes to render the event panel has been reduced, which is most noticeable when selecting multiple events at once.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">The selection is no longer reset when pasting events. The newly pasted events are selected instead.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">The currently selected event for each event group will persist between tabs.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">An object event's sprite will now render if a number is specified instead of a graphics constant.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Palette editor ui is updated a bit to allow hex and rgb value input.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Heal location constants will no longer be deleted if they're not used in the data tables.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">The heal location prefixes <span style=" font-family:'Courier New';">SPAWN_</span> and <span style=" font-family:'Courier New';">HEAL_LOCATION_</span> may now be used interchangeably.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">The number and order of entries in the heal location data tables can now be changed arbitrarily, and independently of each other.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">The metatile behavior is now displayed in the bottom bar mouseover text.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Number values are now allowed in the Tileset Editor's Metatile Behavior field.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Removed some unnecessary error logs from the scripting API and added new useful ones.</li> +<li style="" style=" margin-top:0px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">If any JSON data is the incorrect type Porymap will now attempt to convert it.</li></ul> +<h3 style=" margin-top:14px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><a name="fixed"></a><span style=" font-size:large; font-weight:600;">F</span><span style=" font-size:large; font-weight:600;">ixed</span></h3> +<ul style="margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;"><li style="" style=" margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix events losing their assigned script when the script autocomplete is used.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix the unsaved changes indicator not disappearing when saving changes to events.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix copy and paste for events not including their custom attributes.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix cursor tile outline not updating at the end of a dragged selection.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix cursor tile and player view outlines exiting map bounds while painting.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix cursor tile and player view outlines not updating immediately when toggled in Collision view.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix selected space not updating while painting in Collision view.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix collision values of 2 or 3 not rendering properly.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix the map tree view arrows not displaying for custom themes.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix the map music dropdown being empty when importing a map from Advance Map.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix object events added by pasting ignoring the map event limit.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix a bug where saving the tileset editor would reselect the main editor's first selected metatile.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix crashes / unexpected behavior if certain scripting API functions are given invalid palette or tile numbers.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix drawing large amounts of text with the scripting API causing a significant drop in performance.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Silence unnecessary error logging when parsing C defines Porymap doesn't use.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix some windows like the Tileset Editor not raising to the front when reactivated.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix incorrect limits on Floor Number and Border Width/Height in the New Map Options window.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix Border Width/Height being set to 0 when creating a new map from an existing layout.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix certain UI elements not highlighting red on some platforms.</li> +<li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Fix Open Config Folder not responding</li> +<li style="" style=" margin-top:0px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Properly update the minimum offset for a connection when the map is changed.</li></ul> +<h2 style=" margin-top:16px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><a name="-4-5-0-2021-12-26"></a><a href="https://github.com/huderlem/porymap/compare/4.4.0...4.5.0"><span style=" font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;">4</span></a><span style=" font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;">.5.0</span><span style=" font-size:x-large; font-weight:600;"> - 2021-12-26</span></h2> <h3 style=" margin-top:14px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><a name="added"></a><span style=" font-size:large; font-weight:600;">A</span><span style=" font-size:large; font-weight:600;">dded</span></h3> <ul style="margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;"><li style="" style=" margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">WSL project paths are now supported. (For example, \wsl$\Ubuntu-20.04\home\huderlem\pokeemerald)</li> <li style="" style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Add ability to export map timelapse animated GIFs with <span style=" font-family:'Courier New';">File -&gt; Export Map Timelapse Image...</span>.</li>