Struct moonshine_save::load::Unload

pub struct Unload;

A Component which marks its Entity to be despawned prior to load.

Usage

When saving game state, it is often undesirable to save visual and aesthetic elements of the game. Elements such as transforms, camera settings, scene hierarchy, or UI elements are typically either spawned at game start, or added during initialization of the game data they represent.

This component may be used on such entities to despawn them prior to loading.

Example

use bevy::prelude::*;
use moonshine_save::prelude::*;

#[derive(Bundle)]
struct PlayerBundle {
    player: Player,
    /* Saved Player Data */
    save: Save,
}

#[derive(Component, Default, Reflect)]
#[reflect(Component)]
struct Player;

#[derive(Component)] // <-- Not serialized!
struct PlayerSprite(Entity);

#[derive(Bundle, Default)]
struct PlayerSpriteBundle {
    /* Player Visuals/Aesthetics */
    unload: Unload,
}

fn spawn_player_sprite(query: Query<Entity, Added<Player>>, mut commands: Commands) {
    for entity in &query {
        let sprite = PlayerSprite(commands.spawn(PlayerSpriteBundle::default()).id());
        commands.entity(entity).insert(sprite);
    }
}

Trait Implementations

impl Clone for Unload

fn clone(&self) -> Unload

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for Unload

where Self: 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.

impl Default for Unload

fn default() -> Unload

Returns the “default value” for a type.