Really preserve ObjIDs. #280
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
Previously, when a uoid is read in from the stream, the ObjID from the stream is discarded and reassigned to the value we already know. If the key is not already known, then the next sequential ID is given. If we want to preserve IDs, then we probably want to preserve *all* IDs, even those mid-stream. This is most apparent when diffing PRPs. IDs of zero are special values to the game client that mean "always look this up by name." This situation exists in the wild, right now, on MOULa's BahroCave_District_YeeshaCave.prp. When this file is read, libHSPlasma assigns sequential IDs to the `plMipmap` references in the layers if the Textures PRP is not already loaded. If the common PRP_as_Text.py is used to diff the PRP, a comparison is made against a random/junk value, resulting in a spurious looking change. See H-uru/moul-assets#244 for an example of the confusion.
dpogue
approved these changes
Oct 19, 2023
| * \param preserve Preserve keyed object IDs | ||
| * \sa getPreserveObjIDs() | ||
| */ | ||
| void setPreserveObjIDs(bool preserve) { preserveIDs = preserve; } |
There was a problem hiding this comment.
FWIW, the original reason I didn't expose this except in the constructor was to ensure we couldn't end up in a situation where we had files open with both preserved key IDs and resequenced key IDs in the same ResMgr session.
There was a problem hiding this comment.
Yeah, I was thinking that as well - but I noticed that setVer already had a similar disclaimer, so I felt this was OK.... especially considering it would require re-allocating the res manager it pyResManager__init__() if this function didn't exist.
Deledrius
requested changes
Oct 19, 2023
Co-authored-by: Joseph Davies <[email protected]>
Deledrius
approved these changes
Oct 19, 2023
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.
Previously, when a uoid is read in from the stream, the ObjID from the stream is discarded and reassigned to the value we already know. If the key is not already known, then the next sequential ID is given. If we want to preserve IDs, then we probably want to preserve all IDs, even those mid-stream. This is most apparent when diffing PRPs. IDs of zero are special values to the game client that mean "always look this up by name." This situation exists in the wild, right now, on MOULa's BahroCave_District_YeeshaCave.prp. When this file is read, libHSPlasma assigns sequential IDs to the
plMipmapreferences in the layers if the Textures PRP is not already loaded. If the common PRP_as_Text.py is used to diff the PRP, a comparison is made against a random/junk value, resulting in a spurious looking change. See H-uru/moul-assets#244 for an example of the confusion.