Struct bevy_save::Snapshot

pub struct Snapshot {
    pub entities: Vec<DynamicEntity>,
    pub resources: Vec<Box<dyn Reflect>>,
    /* private fields */
}

A collection of serializable entities and resources.

Can be serialized via SnapshotSerializer and deserialized via SnapshotDeserializer.

Fields

entities: Vec<DynamicEntity>

Entities contained in the snapshot.

resources: Vec<Box<dyn Reflect>>

Resources contained in the snapshot.

Implementations

impl Snapshot

pub fn from_world(world: &World) -> Self

Returns a complete Snapshot of the current [World] state.

Contains all saveable entities and resources, including Rollbacks.

Shortcut for

Snapshot::builder(world)
    .extract_all_with_rollbacks()
    .build();

pub fn builder(world: &World) -> SnapshotBuilder<'_>

Create a SnapshotBuilder from the [World], allowing you to create partial or filtered snapshots.

Example

Snapshot::builder(world)
    // Extract all matching entities and resources
    .extract_all()

    // Clear all extracted entities without any components
    .clear_empty()

    // Build the `Snapshot`
    .build();

pub fn apply(&self, world: &mut World) -> Result<(), Error>

Apply the Snapshot to the [World], using default applier settings.

Errors

If a type included in the Snapshot has not been registered with the type registry.

pub fn applier<'a>(&'a self, world: &'a mut World) -> SnapshotApplier<'_>

Create a SnapshotApplier from the Snapshot and the [World].

This allows you to specify an entity map, hook, etc.

Example

let snapshot = Snapshot::from_world(world);

snapshot
    .applier(world)
    .hook(move |entity, cmds| {
        // You can use the hook to add, get, or remove Components
        if !entity.contains::<Parent>() {
            cmds.set_parent(parent);
        }
    })
    .apply();

Trait Implementations

impl CloneReflect for Snapshot

fn clone_value(&self) -> Self

Clone the value via Reflection.