Add component info to BRP registry schema#23102
Open
splo wants to merge 2 commits intobevyengine:mainfrom
Open
Add component info to BRP registry schema#23102splo wants to merge 2 commits intobevyengine:mainfrom
splo wants to merge 2 commits intobevyengine:mainfrom
Conversation
Contributor
Author
|
This PR relates to issue #23076 but it doesn't fix it: this PR adds the missing component info to BRP while the issue is about adding it to reflect. |
This file contains hidden or 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.
Objective
Add component metadata to the BRP
registry.schemamethod.The following data related to components is missing and this PR adds it:
Other metadata could easily be added, basically everything in the
ComponentInfotype.Solution
World::componentsto obtain an eventualComponentIdandComponentInfo.component_infofield.Testing
Showcase
Here are a few example of the returned JSON schema when calling the BRP
registry.schemamethod:{ "bevy_ecs::hierarchy::ChildOf": { "componentInfo": { "mutable": false, "relationshipKind": "Relationship" }, // Other fields hidden for brevity. }, "bevy_ecs::hierarchy::Children": { "componentInfo": { "mutable": true, "relationshipKind": "RelationshipTarget" }, // Other fields hidden for brevity. }, "bevy_transform::components::transform::Transform": { "componentInfo": { "mutable": true, "requiredComponentTypes": [ "bevy_transform::components::global_transform::GlobalTransform", "bevy_transform::components::transform::TransformTreeChanged" ] }, // Other fields hidden for brevity. }