Add an example demonstrating how to modify the main schedule order #11411
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
D-Trivial
Nice and easy! A great choice to get started with Bevy
Comments
alice-i-cecile
added
C-Docs
|
I'd like to tackle this if no one else is currently working on it! |
|
Awesome, thanks! |
github-merge-queue bot
pushed a commit
that referenced
this issue
Jan 25, 2024
# Objective Fixes #11411 ## Solution - Added a simple example how to create and configure custom schedules that are run by the `Main` schedule. - Spot checked some of the API docs used, fixed `App::add_schedule` docs that referred to a function argument that was removed by #9600. ## Open Questions - While spot checking the docs, I noticed that the `Schedule` label is stored in a field called `name` instead of `label`. This seems unintuitive since the term label is used everywhere else. Should we change that field name? It was introduced in #9600. If so, I do think this change would be out of scope for this PR that mainly adds the example.
tjamaan
pushed a commit
to tjamaan/bevy
that referenced
this issue
Feb 6, 2024
# Objective Fixes bevyengine#11411 ## Solution - Added a simple example how to create and configure custom schedules that are run by the `Main` schedule. - Spot checked some of the API docs used, fixed `App::add_schedule` docs that referred to a function argument that was removed by bevyengine#9600. ## Open Questions - While spot checking the docs, I noticed that the `Schedule` label is stored in a field called `name` instead of `label`. This seems unintuitive since the term label is used everywhere else. Should we change that field name? It was introduced in bevyengine#9600. If so, I do think this change would be out of scope for this PR that mainly adds the example.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
How can Bevy's documentation be improved?
Custom schedules can be added by users, and the order of the
Mainschedule can be changed to meet their needs.However, the path used to do so is not obvious.
To insert a schedule, mutate the
Schedulesresource. Then, mutate theMainScheduleresource to set its ordering.We should add an example demonstrating how to do this, and spot check the related API docs.
The text was updated successfully, but these errors were encountered: