https://github.com/aecsocket/bevy_cleanup

Cleanup design pattern tools for Bevy
https://github.com/aecsocket/bevy_cleanup

Last synced: about 1 month ago
JSON representation

Cleanup design pattern tools for Bevy

• Host: GitHub
• URL: https://github.com/aecsocket/bevy_cleanup
• Owner: aecsocket
• License: apache-2.0
• Created: 2023-08-29T19:09:07.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-29T19:21:50.000Z (about 1 year ago)
• Last Synced: 2024-09-17T02:32:17.737Z (about 2 months ago)
• Language: Rust
• Size: 21.5 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# bevy_cleanup

[![crates.io](https://img.shields.io/crates/v/bevy_cleanup.svg)](https://crates.io/crates/bevy_cleanup)

[![docs.rs](https://img.shields.io/docsrs/bevy_cleanup)](https://docs.rs/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()

        .add_state::()

        .add_state_cleanup::<_, CleanupMenu>(AppState::Menu)

        .add_state_cleanup::<_, CleanupGame>(AppState::Game)

        .add_systems(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 switch_to_game(mut next_state: ResMut>) {

    // After this, any entities with the cleanup component of the current state (`CleanupMenu`)

    // will be automatically recursively despawned.

    next_state.set(AppState::Game);

}

```

# License

Licensed under either of

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or

  http://www.apache.org/licenses/LICENSE-2.0)

- MIT license ([LICENSE-MIT](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.