Struct bevy_asset::NestedLoader

pub struct NestedLoader<'ctx, 'builder> { /* private fields */ }

A builder for loading nested assets inside a LoadContext.

Lifetimes

• ctx: the lifetime of the associated [AssetServer] reference
• builder: the lifetime of the temporary builder structs

Implementations

impl<'ctx, 'builder> NestedLoader<'ctx, 'builder>

pub fn with_settings<S: Settings>( self, settings: impl Fn(&mut S) + Send + Sync + 'static, ) -> Self

Configure the settings used to load the asset.

If the settings type S does not match the settings expected by A’s asset loader, an error will be printed to the log and the asset load will fail.

pub fn with_asset_type<A: Asset>(self) -> Self

Specify the output asset type.

pub fn with_asset_type_id(self, asset_type_id: TypeId) -> Self

Specify the output asset type.

pub fn direct<'c>(self) -> DirectNestedLoader<'ctx, 'builder, 'c>

Load assets directly, rather than creating handles.

pub fn untyped(self) -> UntypedNestedLoader<'ctx, 'builder>

Load assets without static type information.

If you need to specify the type of asset, but cannot do it statically, use .with_asset_type_id().

pub fn load<'c, A: Asset>(self, path: impl Into<AssetPath<'c>>) -> Handle<A>

Retrieves a handle for the asset at the given path and adds that path as a dependency of the asset. If the current context is a normal [AssetServer::load], an actual asset load will be kicked off immediately, which ensures the load happens as soon as possible. “Normal loads” kicked from within a normal Bevy App will generally configure the context to kick off loads immediately. If the current context is configured to not load dependencies automatically (ex: AssetProcessor), a load will not be kicked off automatically. It is then the calling context’s responsibility to begin a load if necessary.