Restore overwrite capabilities of insert_state
#13848
Merged
Conversation
This file contains 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
alice-i-cecile
added
C-Bug
alice-i-cecile
approved these changes
Jun 14, 2024
alice-i-cecile
added
the
S-Needs-Review
ItsDoot
approved these changes
Jun 14, 2024
alice-i-cecile
added
S-Ready-For-Final-Review
benfrankel
approved these changes
Jun 14, 2024
| @@ -70,6 +71,9 @@ impl AppExtStates for SubApp { | |||
| exited: None, | |||
| entered: Some(state), | |||
| }); | |||
| } else { | |||
| let name = std::any::type_name::<S>(); | |||
| warn!("State {} is already initialized.", name); | |||
There was a problem hiding this comment.
I suppose this is reasonable, although .init_resource doesn't warn for this.
| @@ -87,6 +91,16 @@ impl AppExtStates for SubApp { | |||
| exited: None, | |||
| entered: Some(state), | |||
| }); | |||
| } else { | |||
| // Overwrite previous state and setup event | |||
| self.insert_resource::<State<S>>(State::new(state.clone())); | |||
There was a problem hiding this comment.
Noting that there's some duplication between the two branches of the if-else. Pulling them out of the if-else would probably hurt readability, so I won't suggest that :)
There was a problem hiding this comment.
There is a lot of overlap between all the state methods, we can do a cleanup PR later trying to factorize out the common parts
benfrankel
approved these changes
Jun 14, 2024
mockersf
pushed a commit
that referenced
this pull request
Jun 15, 2024
# Objective - Fixes #13844 - Warn user when initializing state multiple times ## Solution - `insert_state` will overwrite previously initialized state value, reset transition events and re-insert it's own transition event. - `init_state`, `add_sub_state`, `add_computed_state` are idempotent, so calling them multiple times will emit a warning. ## Testing - 2 tests confirming overwrite works. - Given the example from #13844 ```rs use bevy::prelude::*; fn main() { App::new() .add_plugins(DefaultPlugins) .insert_state(AppState::A) .insert_state(AppState::B) .add_systems(OnEnter(AppState::A), setup_a) .add_systems(OnEnter(AppState::B), setup_b) .add_systems(OnExit(AppState::A), cleanup_a) .add_systems(OnExit(AppState::B), cleanup_b) .run(); } #[derive(States, Debug, Clone, PartialEq, Eq, Hash)] enum AppState { A, B, } fn setup_a() { info!("setting up A"); } fn setup_b() { info!("setting up B"); } fn cleanup_a() { info!("cleaning up A"); } fn cleanup_b() { info!("cleaning up B"); } ``` We get the following result: ``` INFO states: setting up B ``` which matches our expectations.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Objective
Solution
insert_statewill overwrite previously initialized state value, reset transition events and re-insert it's own transition event.init_state,add_sub_state,add_computed_stateare idempotent, so calling them multiple times will emit a warning.Testing
We get the following result:
which matches our expectations.