Refactor overmap special data #52234
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
Maleclypse
added
[C++]
|
Does refactoring get the infrastructure label? I wasn't sure so I added it. |
BrettDong
reviewed
Oct 11, 2021
|
Looks like I have a few clang-tidy issues. Will probably get to them later today. |
Previously the two types of overmap special (fixed vs mutable) stored their data completely differently. The fixed data was inline, and the mutable data was via a pointer. And all the functions useing those had to switch on the type to decide which to use. Refactor the code so that both types of special are instead derived classes from an abstract overmap_special_data class. This helps clarify some situations that were not handled correctly in the mutable case. Mapgen arguments were not being gathered from mutable special overmaps, the dimensions were not being calculated properly, and they were not respecting the must_be_unexplored flag. The first two of these issues are now fixed; the last remains (but there's now a TODO about it).
jbytheway
force-pushed
the
overmap_special_refactoring
branch
from
b460303
to
f8606da
Compare
|
clang-tidy issues resolved. One remaining CI failure looks unrelated. |
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
None
Purpose of change
Previously the two types of overmap special (fixed vs mutable) stored their data completely differently. The fixed data was inline, and the mutable data was via a pointer. And all the functions using those had to switch on the type to decide which to use. This style of code is ugly and error-prone.
Describe the solution
Refactor the code so that both types of special are instead derived classes from an abstract overmap_special_data class.
This helps clarify some situations that were not handled correctly in the mutable case. Mapgen arguments were not being gathered from mutable special overmaps, the dimensions were not being calculated properly, and they were not respecting the must_be_unexplored flag. The first two of these issues are now fixed; the last remains (but there's now a TODO about it).
Describe alternatives you've considered
Leaving things as they were.
Testing
Unit tests. Loaded a game and checked overmap generation still looks reasonable.
Additional context