Struct ScenePatch 

pub struct ScenePatch {
    pub scene: Option<Box<dyn Scene>>,
    pub dependencies: Vec<UntypedHandle>,
    pub resolved: Option<Arc<ResolvedSceneRoot>>,
}

An Asset that holds a Scene, tracks its dependencies, and holds the ResolvedSceneRoot (after the Scene has been loaded and resolved).

Fields

scene: Option<Box<dyn Scene>>

A Scene.

dependencies: Vec<UntypedHandle>

The dependencies of scene (populated using Scene::register_dependencies). These are “asset dependencies” and will affect the load state.

resolved: Option<Arc<ResolvedSceneRoot>>

The ResolvedSceneRoot, if exists. This is populated after the Scene has been loaded and resolved

Implementations

impl ScenePatch

pub fn load<P>(assets: &AssetServer, scene: P) -> ScenePatch

where P: Scene,

Kicks off a load of the scene. This enumerates the scene’s dependencies using Scene::register_dependencies, loads them using the given AssetServer, and assigns the resulting asset handles to ScenePatch::dependencies.

pub fn load_with<P>( load_from_path: &mut impl LoadFromPath, scene: P, ) -> ScenePatch

where P: Scene,

Same as Self::load, but allows passing in any LoadFromPath impl for more general loading cases.

pub fn resolve( &mut self, assets: &AssetServer, patches: &Assets<ScenePatch>, ) -> Result<(), ResolveSceneError>

Resolves the current scene (using Scene::resolve). This should only be called after every dependency has loaded from the scene’s Scene::register_dependencies. If successful, it will store the resolved result in ScenePatch::resolved.

pub fn spawn<'w>( &self, world: &'w mut World, ) -> Result<EntityWorldMut<'w>, SpawnSceneError>

Spawns the scene in world as a new entity. This should only be called after ScenePatch::resolve.

pub fn apply<'w>( &self, entity: &'w mut EntityWorldMut<'_>, ) -> Result<(), SpawnSceneError>

Applies the scene to the given entity. This should only be called after ScenePatch::resolve

Trait Implementations

impl Asset for ScenePatch

impl TypePath for ScenePatch

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl VisitAssetDependencies for ScenePatch

fn visit_dependencies(&self, visit: &mut impl FnMut(UntypedAssetId))