-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
fix docs around StateTransition
and remove references to `apply_sta…
#13772
fix docs around StateTransition
and remove references to `apply_sta…
#13772
Conversation
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
…lee-orr/bevy into remove-apply-state-transition-from-docs
/// use bevy_state::prelude::*; | ||
/// use bevy_ecs::prelude::*; | ||
/// | ||
/// fn run_state_transitions(world: &mut World) { |
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.
should we just have a exclusive system exported from bevy_state
that does this? It's going to be a small annoyance when migrating to make your own.
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.
I don't feel strongly either way. It's definitely a bit easier, but I like reminding people that they can just run schedules.
#13772) The documentation for the `State` resource still referenced the use of `apply_state_transition` to manually force a state transition to occur, and the question around how to force transitions had come up a few times on discord. This is a docs-only change, that does the following: - Properly references `StateTransition` in the `MainSchedule` docs - replace the explanations for applying `NextState` with ones that explain the `StateTransition` schedule, and mentions the possibility of calling it manually - Add an example of calling `StateTransition` manually in the docs for the state transition schedule itself. --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
The documentation for the
State
resource still referenced the use ofapply_state_transition
to manually force a state transition to occur, and the question around how to force transitions had come up a few times on discord.This is a docs-only change, that does the following:
StateTransition
in theMainSchedule
docsNextState
with ones that explain theStateTransition
schedule, and mentions the possibility of calling it manuallyStateTransition
manually in the docs for the state transition schedule itself.