atiran/porymap
3
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Update manual and changelog

Browse source
This commit is contained in:
GriffinR 2023-02-17 15:17:20 -05:00
parent 6508fd10af
commit 465d51f4a0
2 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -18,6 +18,7 @@ The **"Breaking Changes"** listed below are changes that have been made in the d
- Fix null characters being unpredictably written to some JSON files.
- Fix tilesets that share part of their name loading incorrectly.
- Fix events being hidden behind connecting maps.
- Metatile labels with values defined outside their tileset are no longer deleted.
- Fix some minor visual issues on the Connections tab.
- Fix bug which caused encounter configurator to crash if slots in fields containing groups were deleted.
- Fix bug which caused encounter configurator to crash if last field was deleted.

15
docsrc/manual/tileset-editor.rst
View file

@ -76,12 +76,19 @@ Metatile Label
*optional*
A name can be given to metatiles so that they may be referenced in source code.
These are defined in ``include/constants/metatile_labels.h`` and can be used in
together with the ``METATILE_ID`` macro.
These are defined in ``include/constants/metatile_labels.h``.
For example, the metatile pictured above can be accessed like
``METATILE_ID(General, Plain_Grass)``.
For example, the metatile pictured above can be referenced using the define
``METATILE_General_Grass``.
This define name can be copied using the Copy button next to the metatile label text box.
Sometimes it may be useful to have a ``METATILE`` define that applies to many tilesets.
This can be done by manually creating a ``METATILE`` define with a value outside its tileset.
For example, the primary tileset ``SecretBase`` is associated with many secondary tilesets,
all of which use the same labels. ``#define METATILE_SecretBase_PC 0x220`` defines a label
for the secondary metatile id ``0x220`` which will be used by any secondary tileset that's
paired with ``SecretBase``. Labels like this will appear gray in the text box, and can't
be edited from within Porymap; they must be edited manually in ``metatile_labels.h``.