[Merged by Bors] - Add component_id function to World and Components #5066
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
GarettCooper
force-pushed
the
component_id_access
branch
from
684e166
to
df727b0
Compare
GarettCooper
commented
Jun 22, 2022
| /// A [`ComponentId`] is tightly coupled to its parent [`World`](crate::world::World). | ||
| /// Attempting to use a [`ComponentId`] from one [`World`](crate::world::World) to access the metadata | ||
| /// of a [`Component`] in a different [`World`](crate::world::World) is undefined behaviour and should | ||
| /// not be attempted. | ||
| #[derive(Debug, Copy, Clone, Hash, Ord, PartialOrd, Eq, PartialEq)] | ||
| pub struct ComponentId(usize); |
There was a problem hiding this comment.
I think we should consider talking a bit about the relationship with TypeId here too.
Basically, for Rust types, there's a one-to-one mapping between TypeId and ComponentId. But non-Rust components can be used (well, only kind of so far), and these also get their own ComponentId.
There was a problem hiding this comment.
I've added a new section to explain the relationship. I'm not totally happy with the last sentence "Each Rust type ... or other advanced use cases" since it's pretty clunky, but after fiddling with it for a bit I couldn't come up with anything that wasn't quite a bit more verbose. Suggestions appreciated.
alice-i-cecile
requested changes
Jun 22, 2022
alice-i-cecile
added
A-ECS
GarettCooper
force-pushed
the
component_id_access
branch
from
4e7ba81
to
ab8cfc4
Compare
Nilirad
suggested changes
Jun 22, 2022
There was a problem hiding this comment.
Good job, your descriptions are very nice overall.
I added some nits that helps significantly improve the form of the rendered docs.
Also, keep in mind that adding a link to the same item multiple times within the same item will lower the consulting experience (it looks like there are a lot of connections while actually there are a lot less).
You can view the rendered docs by yourself by using the following command, in case you didn't know:
cargo doc -p bevy_ecs --no-deps --open
Still great work anyway 😀
GarettCooper
force-pushed
the
component_id_access
branch
from
b560c74
to
ad5120e
Compare
GarettCooper
force-pushed
the
component_id_access
branch
from
ad5120e
to
25a6e3f
Compare
Nilirad
suggested changes
Jun 23, 2022
alice-i-cecile
approved these changes
Jun 24, 2022
Nilirad
approved these changes
Jun 24, 2022
Nilirad
approved these changes
Jun 25, 2022
|
bors r+ |
bors bot
pushed a commit
that referenced
this pull request
Jun 25, 2022
# Objective - Simplify the process of obtaining a `ComponentId` instance corresponding to a `Component`. - Resolves #5060. ## Solution - Add a `component_id::<T: Component>(&self)` function to both `World` and `Components` to retrieve the `ComponentId` associated with `T` from a immutable reference. --- ## Changelog - Added `World::component_id::<C>()` and `Components::component_id::<C>()` to retrieve a `Component`'s corresponding `ComponentId` if it exists.
alice-i-cecile
added
the
S-Ready-For-Final-Review
bors
bot
changed the title
inodentry
pushed a commit
to IyesGames/bevy
that referenced
this pull request
Aug 8, 2022
# Objective - Simplify the process of obtaining a `ComponentId` instance corresponding to a `Component`. - Resolves bevyengine#5060. ## Solution - Add a `component_id::<T: Component>(&self)` function to both `World` and `Components` to retrieve the `ComponentId` associated with `T` from a immutable reference. --- ## Changelog - Added `World::component_id::<C>()` and `Components::component_id::<C>()` to retrieve a `Component`'s corresponding `ComponentId` if it exists.
james7132
pushed a commit
to james7132/bevy
that referenced
this pull request
Oct 28, 2022
# Objective - Simplify the process of obtaining a `ComponentId` instance corresponding to a `Component`. - Resolves bevyengine#5060. ## Solution - Add a `component_id::<T: Component>(&self)` function to both `World` and `Components` to retrieve the `ComponentId` associated with `T` from a immutable reference. --- ## Changelog - Added `World::component_id::<C>()` and `Components::component_id::<C>()` to retrieve a `Component`'s corresponding `ComponentId` if it exists.
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
# Objective - Simplify the process of obtaining a `ComponentId` instance corresponding to a `Component`. - Resolves bevyengine#5060. ## Solution - Add a `component_id::<T: Component>(&self)` function to both `World` and `Components` to retrieve the `ComponentId` associated with `T` from a immutable reference. --- ## Changelog - Added `World::component_id::<C>()` and `Components::component_id::<C>()` to retrieve a `Component`'s corresponding `ComponentId` if it exists.
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
ComponentIdinstance corresponding to aComponent.ComponentIdfor a givenComponenttype #5060.Solution
component_id::<T: Component>(&self)function to bothWorldandComponentsto retrieve theComponentIdassociated withTfrom a immutable reference.Changelog
World::component_id::<C>()andComponents::component_id::<C>()to retrieve aComponent's correspondingComponentIdif it exists.