Document original player animation names in gameplay_keep
#1786
+656
−656
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 PR might seem a bit redundant, since the player animations are currently named after their original names (if the original name is available). The reason I want to do this, however, is that player animation names are probably going to change in the future, and I want to preserve these original names in the comments. This might seem silly:
But it seems much more reasonable when the animation is renamed:
I've described the history of how I derived these original animation names in previous PRs, but to summarize, Grezzo included almost all of the original animation data (just converted to little endian) for OoT's animations in OoT3D; for these animations, I wrote in the comment that the "original name is [name]", since we can be extremely confident in the names of these ones. For animations new to MM, I needed to look at the animation in MM3D and try to match it up with the N64 asset. Since I could be wrong about this (though I believe I got them correct; note how the original animation names follow a consistent alphabetical scheme), for these animations I wrote in the comment that the "original name might be [name]". A secondary benefit of this PR is that the repo itself now contains this distinction between original animation names that we know almost for certain and original animation names that might not be entirely accurate.