Struct LoadWorld 

pub struct LoadWorld<U = Or<(With<Save>, With<Unload>)>>
where
    U: QueryFilter,
{
    pub input: LoadInput,
    pub mapper: SceneMapper,
    /* private fields */
}

A generic LoadEvent which loads the world from a file or stream.

Fields

input: LoadInput

The input data used to load the world.

mapper: SceneMapper

A SceneMapper used to map components after the load process.

Implementations

impl<U> LoadWorld<U>

where U: QueryFilter,

pub fn new(input: LoadInput, mapper: SceneMapper) -> LoadWorld<U>

Creates a new LoadWorld with the given input and mapper.

pub fn from_file(path: impl Into<PathBuf>) -> LoadWorld<U>

Creates a new LoadWorld which unloads entities matching the given QueryFilter before the file at given path.

pub fn from_stream(stream: impl LoadStream) -> LoadWorld<U>

Creates a new LoadWorld which unloads entities matching the given QueryFilter before loading from the given Read stream.

pub fn map_component<T>(self, m: impl MapComponent<T>) -> LoadWorld<U>

where T: Component,

Maps the given Component into another using a component mapper after loading.

impl LoadWorld

pub fn default_from_file(path: impl Into<PathBuf>) -> LoadWorld

Creates a new LoadWorld event which unloads default entities (with Unload or Save) before loading the file at the given path.

pub fn default_from_stream(stream: impl LoadStream) -> LoadWorld

Creates a new LoadWorld event which unloads default entities (with Unload or Save) before loading from the given Read stream.

Trait Implementations

impl<U> LoadEvent for LoadWorld<U>

where U: QueryFilter + Static,

type UnloadFilter = U

A QueryFilter used as the initial filter for selecting entities to unload.

fn input(&mut self) -> LoadInput

Returns the LoadInput of the load process.

fn before_load(&mut self, world: &mut World)

Called once before the load process starts.

fn after_load(&mut self, world: &mut World, result: &Result<Loaded, LoadError>)

Called for all entities after they have been loaded.

fn before_unload(&mut self, _world: &mut World, _entities: &[Entity])

Called once before unloading entities.

impl<U> SingleEvent for LoadWorld<U>

where U: QueryFilter + Static,