-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
Add custom schedule example #11527
Add custom schedule example #11527
Conversation
The generated |
I think the comment above is inaccurate. I fixed the issue in 218e570, before CI failed. Running the command again results in an empty changeset. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Agreed on the change suggested, and agreed it should be its own PR.
# Objective While working on #11527 I spotted that the internal field for the label of a `Schedule` is called `name`. Using `label` seems more in line with the other naming across Bevy. ## Solution Renaming the field was straightforward since it's not exposed outside of the module. This also means a changelog or migration guide isn't necessary.
# 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.
# Objective While working on bevyengine#11527 I spotted that the internal field for the label of a `Schedule` is called `name`. Using `label` seems more in line with the other naming across Bevy. ## Solution Renaming the field was straightforward since it's not exposed outside of the module. This also means a changelog or migration guide isn't necessary.
Objective
Fixes #11411
Solution
Main
schedule.App::add_schedule
docs that referred to a function argument that was removed by Move schedule name intoSchedule
#9600.Open Questions
Schedule
label is stored in a field calledname
instead oflabel
. This seems unintuitive since the term label is used everywhere else. Should we change that field name? It was introduced in Move schedule name intoSchedule
#9600. If so, I do think this change would be out of scope for this PR that mainly adds the example.