Module moonshine_save::save

Elements related to saving world state.

Example

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

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

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

app.world.spawn((Data(12), Save));
app.update();

let data = std::fs::read_to_string("example.ron").unwrap();

Structs

• DynamicSavePipelineBuilder
  A convenient builder for defining a SavePipeline with a dynamic SaveFilter which can be provided from any System.
• Save
  A Component which marks its Entity to be saved.
• SaveFilter
• SavePipelineBuilder
  A convenient builder for defining a SavePipeline.
• SavePlugin
  A Plugin which configures SaveSystem in PreUpdate schedule.
• Saved
  A Resource which contains the saved World data during SaveSystem::PostSave.

Enums

• EntityFilter
• SaveError
• SaveSystem
  A SystemSet for systems that process saving.

Traits

• SaveIntoFileRequest
  Any type which may be used to trigger [save_into_file_on_request] or [save_into_file_on_event].

Functions

• file_from_event
  A System which extracts the path from a SaveIntoFileRequest Event.
• file_from_request
  A System which extracts the path from a SaveIntoFileRequest Resource.
• filter
• filter_entities
• finish
  A System which finishes the save process.
• into_file
  A System which writes Saved data into a file at given path.
• into_file_dyn
  A System which writes Saved data into a file with its path defined at runtime.
• save
  Creates a SavePipelineBuilder which saves all entities with given entity filter F.
• save_all
  Creates a SavePipelineBuilder which saves all entities unconditionally.
• save_all_with
  Creates a DynamicSavePipelineBuilder which saves all entities unconditionally and a filter source S.
• save_default
  Creates a SavePipelineBuilder which saves all entities with a Save component.
• save_default_with
  Creates a DynamicSavePipelineBuilder which saves all entities with a Save component and a filter source S.
• save_scene
  A System which creates Saved data from all entities with given Filter.
• save_with
  Creates a DynamicSavePipelineBuilder which saves all entities with given entity filter F and a filter source S.

Type Aliases

• SavePipeline
  A collection of systems (SystemConfigs) which perform the save process.