Struct SaveProjectEvent

pub struct SaveProjectEvent {
    pub(crate) project: Entity,
    pub(crate) output: PathBuf,
}

When this event is sent, the associated project will be fetched and saved. As a reaction to this event, a system will build a [bevy::prelude::Query] that attempts to fetch all [data::Project]’s [data::Level]s (and their descendant [data::Layer]s along all their descendants) and then (attempts) to persist them to disk.

The [data::Project] fetched is queried by the SaveProjectEvent::project [Entity], the user is responsible for only emitting “valid” entities, as this crate will assume they are, and according to Bevy’s own documentation, this can lead to undefined behaviour if not respected.

Fields

project: Entity

The [Entity] of the [data::Project] to save.

output: PathBuf

The output path of the savefile that will be created.

Implementations

impl SaveProjectEvent

pub fn new(project: Entity, output: PathBuf) -> Self

Generate a new SaveProjectEvent that can be dispatched.

Trait Implementations

impl Debug for SaveProjectEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Event for SaveProjectEvent

where Self: Send + Sync + 'static,

const AUTO_PROPAGATE: bool = false

When true, this event will always attempt to propagate when triggered, without requiring a call to Trigger::propagate.

type Traversal = ()

The component that describes which Entity to propagate this event to next, when propagation is enabled.

fn register_component_id(world: &mut World) -> ComponentId

Generates the [ComponentId] for this event type.

fn component_id(world: &World) -> Option<ComponentId>

Fetches the [ComponentId] for this event type, if it has already been generated.