Update CHANGELOG and docsrc

This commit is contained in:
BigBahss 2020-10-02 22:13:59 -04:00
parent fb5e35bd5f
commit e50d562efe
4 changed files with 24 additions and 7 deletions

View file

@ -15,6 +15,7 @@ The **"Breaking Changes"** listed below are changes that have been made in the d
- The New Map dialog now gives an option to specify the "Show Location Name" field.
- Some new shortcuts were added in [porymap/#290](https://github.com/huderlem/porymap/pull/290).
- All plain text boxes now have a clear button to delete the text.
- Add ruler tool for measuring metatile distance in events tab (Right-click to turn on/off, left-click to lock in place).
### Changed
- Holding `shift` now toggles "Smart Path" drawing; when the "Smart Paths" checkbox is checked, holding `shift` will temporarily disable it.
@ -22,7 +23,7 @@ The **"Breaking Changes"** listed below are changes that have been made in the d
### Fixed
- Fix a bug with the current metatile selection zoom.
- Fix bug preventing the status bar from updating the current position while dragging events.
- Fix porymap icon not showing on window or panel on Linux
- Fix porymap icon not showing on window or panel on Linux.
## [4.3.1] - 2020-07-17
### Added

View file

@ -237,17 +237,32 @@ The event editing tab also extends functionality to a few of the tool buttons de
A brief description and animation is listed for each of the available tools below:
Pencil
When clicking on an existing event, the pencil tool will behave normally (as the standard cursor). It can also be used to "draw" events in a certain location. The event created will be a default-valued event of the same type as the currently selected event.
When clicking on an existing event, the pencil tool will behave normally (as the standard cursor). It can also be used to "draw" events in a certain location. The event created will be a default-valued event of the same type as the currently selected event. Right-clicking with the Pencil Tool will return to the Pointer tool.
.. figure:: images/editing-map-events/event-tool-pencil.gif
:alt: Drawing Object Events with the Pencil Tool
Drawing Object Events with the Pencil Tool
Pointer
The Pointer Tool is the default tool for the event editing tab and allows you to select and move events on the map. The Pointer Tool also gives you access to the :ref:`Ruler Tool <ruler-tool>`.
Shift
You can use the shift tool to move any number of events together. When a selected event is dragged, all other selected events will move with it. When a tile with no event is clicked, all events on the map can be dragged.
You can use the Shift Tool to move any number of events together. When a selected event is dragged, all other selected events will move with it. When a tile with no event is clicked, all events on the map can be dragged.
.. figure:: images/editing-map-events/event-tool-shift.gif
:alt: Moving Events with the Shift Tool
Moving Events with the Shift Tool
.. _ruler-tool:
Ruler Tool
----------
The Ruler Tool provides a convenient way to measure distance on the map. This is particularly useful for scripting object movement. With the Pointer Tool selected you can activate the ruler with a Right-click. With the ruler active you can drag the mouse around to extend the ruler. The ruler can be deactivated with another Right-click, or locked in place with a Left-click (Left-click again to unlock the ruler). The dimensions of the ruler are displayed in a tool-tip and in the status bar in the bottom left corner of the widnow.
.. figure:: images/editing-map-events/event-tool-ruler.gif
:alt: Measuring metatile distance with the Ruler Tool
Measuring metatile distance with the Ruler Tool

Binary file not shown.

After

Width:  |  Height:  |  Size: 231 KiB

View file

@ -38,10 +38,10 @@ Main Window
:header: Map Editing
:widths: 20, 20
Select Tiles From Map, Hold Right-click while dragging
Select Metatile, Right-click in "paint" or "fill" mode
Select Multiple Metatiles, Hold Right-click while dragging
Bucket Fill Metatiles, Middle-click from "paint" or "fill" mode
Magic Fill Metatiles, ``Ctrl+`` Middle-click from "paint" or "fill" mode
Select Metatile, Right-click in "paint" or "fill" mode
Zoom In, ``Ctrl++`` `or` ``Ctrl+=``
Zoom Out, ``Ctrl+-``
Reset View Scale, ``Ctrl+0``
@ -52,8 +52,9 @@ Main Window
Draw Straight Paths, Hold ``Ctrl``
Duplicate Event(s), ``Ctrl+D`` while selected
Delete Event(s), ``DEL`` while selected
Select Event, Right-click in paint mode
Update Event Selection, `Ctrl+` click
Pointer, Right-click in "paint" mode
Select Event, Left-click in "pointer" mode or Right-click in "paint" mode
Select Multiple Events, `Ctrl+` click