Fix TileMapLayer bug where dirty cells could be marked twice #102688
Merged
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
When using runtime data in a TileMapLayer, calling notify_runtime_tile_update can cause error messages to be printed to the console if the same cell has been set or erased in the same frame. This could be partially worked around by using call_deferred on notify_runtime_tile_update, but the problem could re-emerge if those updates were being made in coroutines. This commit addresses the issue by adding an additional check to the dirty cell marking of the TileMapLayer when notify_runtime_tile_update is called. This check ensures that the cell has not already been added to the dirty cell list, preventing the condition that causes the error message.
groud
approved these changes
Feb 11, 2025
akien-mga
added
the
cherrypick:4.3
|
Thanks! And congrats for your first merged Godot contribution 🎉 |
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.
Summary
Adds additional checks to
TileMapLayer::_build_runtime_update_tile_data_for_cellto ensure that dirty cells have not already been added to the dirty cells list before callingdirty.cell_list.add(...). Previously, updating a cell and callingnotify_runtime_tile_data_updatein the same frame or through coroutines could cause ordering issues here resulting in a large number of error messages being printed.Using the MRC provided in the linked issue, I verified that the errors are no longer being printed, and calling
notify_runtime_tile_data_updateusingcall_deferredis no longer necessaryI'm also attaching an MRC to this PR for the case where messages can still be printed when using
call_deferredif coroutines are involved. Adding these additional checks prevent the error messages in this MRC as well: Coroutine MRC