Fixed map reload in case map is open as part of a world #3939
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bjorn
commented
May 2, 2024
bjorn
force-pushed
the
fix-map-reload
branch
3 times, most recently
from
d46cff7
to
6d75839
Compare
bjorn
force-pushed
the
fix-map-reload
branch
2 times, most recently
from
1ad8eb9
to
d0246cc
Compare
I've extended the changes in this PR with another change that makes sure any loaded document is watched for changes on disk and reloaded when appropriate (when it doesn't have unsaved changes). This not only applies to maps loaded as part of a world, but also to tilesets that are loaded as part of maps (issue #1785). |
Maps are now reloaded the same way as tilesets, by swapping the internal data of the MapDocument rather than replacing the entire document. This also means undo history is kept, since the reload is added as an undoable action. This fixes map reload to also affect instances that are open as part of a world. Previously, the old version would stay open in the world. However, maps that are only open as part of a world are not yet watched for changes. This is a somewhat risky change since the code was never prepared for the map and its internal structures to be replaced entirely without any specific change events. New "DocumentAboutToReload" and "DocumentReloaded" events were added, which are hopefully handled in all the right places. Selected layers and objects, as well as expanded group layers, are restored after reload by ID. This change also addresses several issues with reloading tilesets. Added tiled.assetReloaded signal to the scripting API. Most scripts will not have to do anything,, but some might. Fixed enabled state of Reload action, which shouldn't be always enabled for maps (since we can only reload maps when they have a file name and we know the file format). Closes mapeditor#3927
When a map is loaded as part of a world, or a tileset is loaded as part of a map, but not open in its own editor, previously its file was not watched for changes. Now these files are also watched. When a change is detected and no unsaved changes are present, the affected map or tileset will be reloaded. Closes mapeditor#1785
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a re-implementation of the way maps are reloaded, to make sure the reload affects all instances and not just the opened editor tab. Previously, the reload was implemented by closing and reopening that tab, which was only a viable method before the implementation of worlds.
This is a rather risky change since the code was never prepared for the map and its internal structures to be replaced entirely without any specific change events. There's a high probability of leaving a roaming pointer somewhere.
Marked as draft because there are a few open tasks:
Fixes part of issue #3927 (though not entirely, since that would require watching map files for changes also when they aren't open in their own tab).