bevy_cleanup

Providers helpers for using the cleanup design pattern in Bevy, where entities are automatically removed after a state transition, depending on any Cleanup marker components they have.

```rs use bevy::prelude::*; use bevy_cleanup::{Cleanup, AddStateCleanup};

// Set up your States enum and keep your Cleanup component types close by

[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default, States)]

enum AppState { #[default] Menu, Game, }

[derive(Component, Cleanup)]

struct CleanupMenu;

[derive(Component, Cleanup)]

struct CleanupGame;

// Set up your App

fn main() { App::new() .addstate::() .addstatecleanup::<_, CleanupMenu>(AppState::Menu) .addstatecleanup::<_, CleanupGame>(AppState::Game) .addsystems(OnEnter(AppState::Menu), setup_menu) .run(); }

fn setup_menu(mut commands: Commands) { // When spawning an entity, give it one of your Cleanup component types // Typically, you put the Name and Cleanup types at the top of the component tuple commands.spawn(( Name::new("Menu entity"), CleanupMenu, // everything else... )); }

// When you want to switch from Menu to Game... fn switchtogame(mut nextstate: ResMut>) { // After this, any entities with the cleanup component of the current state (CleanupMenu) // will be automatically recursively despawned. nextstate.set(AppState::Game); } ```

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.