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

SystemState can be cached using its ExclusiveSystemParam implementation, but the docs don't mention this. #12587

Open
Themayu opened this issue Mar 20, 2024 · 0 comments
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@Themayu
Copy link
Contributor

Themayu commented Mar 20, 2024

How can Bevy's documentation be improved?

This issue is a more specific form of #8770, which has been open for over nine months with no apparent resolution.

The caching example for SystemState in the documentation shows the use of a function-local struct to cache a SystemState object. However, caching a SystemState has gotten easier since this documentation was written - with the addition of ExclusiveSystemParam and its implementation on &'a mut SystemState<P>, we can have the ECS handle caching for us.

The documentation should be updated to reflect this.

@Themayu Themayu added C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled labels Mar 20, 2024
@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy A-ECS Entities, components, systems, and events and removed S-Needs-Triage This issue needs to be labelled labels Mar 20, 2024
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 D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Development

No branches or pull requests

2 participants