Skip to content
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

RemovedComponents is missing documentation #1920

Closed
alice-i-cecile opened this issue Apr 13, 2021 · 1 comment
Closed

RemovedComponents is missing documentation #1920

alice-i-cecile opened this issue Apr 13, 2021 · 1 comment
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation C-Examples An addition or correction to our examples

Comments

@alice-i-cecile
Copy link
Member

How can Bevy's documentation be improved?

RemovedComponents is missing documentation.

We should provide reference docs on what it does, and a quick example in examples/ecs demonstrating how you might use it in practice.

As I understand it, what this does is return all components of type T that were removed since the start of the frame. Using this in concert with a more complex query would be a great fit for the full example.

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled A-ECS Entities, components, systems, and events C-Examples An addition or correction to our examples and removed S-Needs-Triage This issue needs to be labelled labels Apr 13, 2021
@MJohnson459
Copy link
Contributor

While I was searching for how RemovedComponents works, I found an example already exists:
https://github.com/bevyengine/bevy/blob/81b53d15d4e038261182b8d7c8f65f9a3641fd2d/examples/ecs/removal_detection.rs

Also this is a more complex example which might be useful for others:
https://github.com/dimforge/bevy_rapier/blob/6de85b0a7949d91aa32b78be0d51b2d08bbd13af/src/physics/systems.rs#L382

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation C-Examples An addition or correction to our examples
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants