forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Warn about missing StatesPlugin when installing states (#13877)

Browse Source 
# Objective

- Fixes #13874

## Solution

- Confirm that the `StatesPlugin` is installed when trying to add
states.
- Skipped for state scoped entities, since those will warn about missing
states.
This commit is contained in:
MiniaczQ 2024-06-16 19:36:24 +02:00 committed by François
parent 1c838ff6b3
commit 6cf04c213b
No known key found for this signature in database
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
crates/bevy_state/src/app.rs
View File

@ -4,7 +4,7 @@ use bevy_ecs::{
schedule::{IntoSystemConfigs, ScheduleLabel}, schedule::{IntoSystemConfigs, ScheduleLabel},
world::FromWorld, world::FromWorld,
}; };
use bevy_utils::tracing::warn; use bevy_utils::{tracing::warn, warn_once};
use crate::state::{ use crate::state::{
setup_state_transitions_in_world, ComputedStates, FreelyMutableState, NextState, State, setup_state_transitions_in_world, ComputedStates, FreelyMutableState, NextState, State,
@ -57,8 +57,16 @@ pub trait AppExtStates {
fn enable_state_scoped_entities<S: States>(&mut self) -> &mut Self; fn enable_state_scoped_entities<S: States>(&mut self) -> &mut Self;
} }
/// Separate function to only warn once for all state installation methods.
fn warn_if_no_states_plugin_installed(app: &SubApp) {
if !app.is_plugin_added::<StatesPlugin>() {
warn_once!("States were added to the app, but `StatesPlugin` is not installed.");
}
}
impl AppExtStates for SubApp { impl AppExtStates for SubApp {
fn init_state<S: FreelyMutableState + FromWorld>(&mut self) -> &mut Self { fn init_state<S: FreelyMutableState + FromWorld>(&mut self) -> &mut Self {
warn_if_no_states_plugin_installed(self);
if !self.world().contains_resource::<State<S>>() { if !self.world().contains_resource::<State<S>>() {
setup_state_transitions_in_world(self.world_mut(), Some(Startup.intern())); setup_state_transitions_in_world(self.world_mut(), Some(Startup.intern()));
self.init_resource::<State<S>>() self.init_resource::<State<S>>()
@ -80,6 +88,7 @@ impl AppExtStates for SubApp {
} }
fn insert_state<S: FreelyMutableState>(&mut self, state: S) -> &mut Self { fn insert_state<S: FreelyMutableState>(&mut self, state: S) -> &mut Self {
warn_if_no_states_plugin_installed(self);
if !self.world().contains_resource::<State<S>>() { if !self.world().contains_resource::<State<S>>() {
setup_state_transitions_in_world(self.world_mut(), Some(Startup.intern())); setup_state_transitions_in_world(self.world_mut(), Some(Startup.intern()));
self.insert_resource::<State<S>>(State::new(state.clone())) self.insert_resource::<State<S>>(State::new(state.clone()))
@ -107,6 +116,7 @@ impl AppExtStates for SubApp {
} }
fn add_computed_state<S: ComputedStates>(&mut self) -> &mut Self { fn add_computed_state<S: ComputedStates>(&mut self) -> &mut Self {
warn_if_no_states_plugin_installed(self);
if !self if !self
.world() .world()
.contains_resource::<Events<StateTransitionEvent<S>>>() .contains_resource::<Events<StateTransitionEvent<S>>>()
@ -132,6 +142,7 @@ impl AppExtStates for SubApp {
} }
fn add_sub_state<S: SubStates>(&mut self) -> &mut Self { fn add_sub_state<S: SubStates>(&mut self) -> &mut Self {
warn_if_no_states_plugin_installed(self);
if !self if !self
.world() .world()
.contains_resource::<Events<StateTransitionEvent<S>>>() .contains_resource::<Events<StateTransitionEvent<S>>>()
@ -158,8 +169,6 @@ impl AppExtStates for SubApp {
} }
fn enable_state_scoped_entities<S: States>(&mut self) -> &mut Self { fn enable_state_scoped_entities<S: States>(&mut self) -> &mut Self {
use bevy_utils::tracing::warn;
if !self if !self
.world() .world()
.contains_resource::<Events<StateTransitionEvent<S>>>() .contains_resource::<Events<StateTransitionEvent<S>>>()