Struct moonshine_save::save::SavePipelineBuilder

pub struct SavePipelineBuilder<F: QueryFilter> { /* private fields */ }

A convenient builder for defining a SavePipeline.

See save, save_default, save_all on how to create an instance of this type.

Implementations

impl<F> SavePipelineBuilder<F>

where F: 'static + QueryFilter,

pub fn include_resource<R: Resource>(self) -> Self

Includes a given Resource type into the save pipeline.

By default, all resources are excluded from the save pipeline.

Example

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

#[derive(Resource, Default, Reflect)]
#[reflect(Resource)]
struct R;

let mut app = App::new();
app.register_type::<R>()
    .insert_resource(R)
    .add_plugins((MinimalPlugins, SavePlugin))
    .add_systems(
        PreUpdate,
        save_default()
            .include_resource::<R>()
            .into_file("example.ron"));

pub fn include_resource_by_id(self, type_id: TypeId) -> Self

Includes a given Resource type into the save pipeline by its TypeId.

pub fn exclude_component<T: Component>(self) -> Self

Excludes a given Component type from the save pipeline.

By default, all components which derive Reflect are included in the save pipeline.

Example

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

#[derive(Resource, Default, Reflect)]
#[reflect(Resource)]
struct R;

let mut app = App::new();
app.register_type::<R>()
    .insert_resource(R)
    .add_plugins((MinimalPlugins, SavePlugin))
    .add_systems(
        PreUpdate,
        save_default()
            .exclude_component::<Transform>()
            .into_file("example.ron"));

pub fn exclude_component_by_id(self, type_id: TypeId) -> Self

Excludes a given Component type from the save pipeline by its TypeId.

pub fn into_file(self, path: impl Into<PathBuf>) -> SavePipeline

Finishes the save pipeline by writing the saved data into a file at given path.

pub fn into_file_on_request<R: FilePath + Resource>(self) -> SavePipeline

Finishes the save pipeline by writing the saved data into a file with its path derived from a resource of type R.

The save pipeline will only be triggered if a resource of type R is present.

pub fn into_file_on_event<R: FilePath + Event>(self) -> SavePipeline

Finishes the save pipeline by writing the saved data into a file with its path derived from an event of type R.

The save pipeline will only be triggered if an event of type R is sent.

Warning

If multiple events are sent in a single update cycle, only the first one is processed.