Crate io

DungeonRS io

This crate handles persisting and loading data to and from the disk.

Modules

document 🔒

The Document structs are used for writing and loading [data::Project] entities to and from storage. This module is intentionally not made public, since these structs have no use beyond persistence and should not be used outside this scope.

load_project 🔒

Contains the LoadProjectEvent and it’s handler systems.

plugin 🔒

Contains the IOPlugin that registers the required systems and data in the bevy App.

save_project 🔒

Contains the events for saving projects and their handling systems.

Structs

IOPlugin

Sets up listening for events to persist or load data from the disk.

LoadProjectEvent

Emitting this event will cause the software to attempt loading a project file at the given input.

SaveProjectCompleteEvent

This event indicates that the work of a SaveProjectEvent has completed.

SaveProjectEvent

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.