Struct bevy::prelude::StateScoped

pub struct StateScoped<S>(pub S)
where
    S: States;

Entities marked with this component will be removed when the world’s state of the matching type no longer matches the supplied value.

To enable this feature remember to configure your application with enable_state_scoped_entities on your state(s) of choice.

If bevy_hierarchy feature is enabled, which it is by default, the despawn will be recursive.

use bevy_state::prelude::*;
use bevy_ecs::prelude::*;

#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, Default, States)]
enum GameState {
    #[default]
    MainMenu,
    SettingsMenu,
    InGame,
}


fn spawn_player(mut commands: Commands) {
    commands.spawn((
        StateScoped(GameState::InGame),
        Player
    ));
}


app.init_state::<GameState>();
app.enable_state_scoped_entities::<GameState>();
app.add_systems(OnEnter(GameState::InGame), spawn_player);

Tuple Fields

0: S

Trait Implementations

impl<S> Component for StateScoped<S>

where S: States, StateScoped<S>: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.