-
Notifications
You must be signed in to change notification settings - Fork 42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Start tracking 'canonical properties' #28
Merged
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
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 PR is a robust solution for #18, #14, and is a step towards #16.
This change introduces the idea of a canonical property more concretely. This idea helps us map from serialization-specific names onto common names that projects can agree on for referring to the same idea.
The concept for property canonicalization came out of Rojo, and seeks to handle these cases:
Fire.Size
CollectionService
tagsLighting.Technology
A new file was added to generate_reflection called
canonical-properties.toml
that specifies these relationships. Previously, these ideas were present in rbx_xml's ad hoc reflection database, but they're needed for rbx_binary as well.There are a couple of assumptions that this approach makes:
While I'm sure about (1), there are non-trivial cases where (2) doesn't hold up. The most notable example is part color, which used to be
BrickColor
, but is nowColor3uint8
, which requires a name and type conversion toColor3
before it can be reflected to Lua.