fix docs around StateTransition and remove references to `apply_sta…#13772
Merged
alice-i-cecile merged 6 commits intobevyengine:mainfrom Jun 10, 2024
Merged
Conversation
alice-i-cecile
approved these changes
Jun 9, 2024
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
alice-i-cecile
added
C-Docs
…lee-orr/bevy into remove-apply-state-transition-from-docs
benfrankel
approved these changes
Jun 9, 2024
hymm
reviewed
Jun 9, 2024
| /// use bevy_state::prelude::*; | ||
| /// use bevy_ecs::prelude::*; | ||
| /// | ||
| /// fn run_state_transitions(world: &mut World) { |
Contributor
There was a problem hiding this comment.
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.
Member
There was a problem hiding this comment.
I don't feel strongly either way. It's definitely a bit easier, but I like reminding people that they can just run schedules.
MiniaczQ
approved these changes
Jun 9, 2024
mockersf
pushed a commit
that referenced
this pull request
Jun 10, 2024
#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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The documentation for the
Stateresource still referenced the use ofapply_state_transitionto 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:
StateTransitionin theMainScheduledocsNextStatewith ones that explain theStateTransitionschedule, and mentions the possibility of calling it manuallyStateTransitionmanually in the docs for the state transition schedule itself.