forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add note about asset source register order (#10186)

Browse Source 
# Objective

I encountered a problem where I had a plugin `FooPlugin` which did

```rust
impl Plugin for FooPlugin {
    fn build(&self, app: &mut App) {
        app
           .register_asset_source(...); // more stuff after
    }
}
```

And when I tried using it, e.g.

```rust
asset_server.load("foo://data/asset.custom");
```

I got an error that `foo` was not recognized as a source.

I found that this is because asset sources must be registered _before_
`AssetPlugin` is added, and I had `FooPlugin` _after_.

## Solution

Add clarifying note about having to register sources before
`AssetPlugin` is added.

Signed-off-by: Torstein Grindvik <torstein.grindvik@muybridge.com>
Co-authored-by: Torstein Grindvik <torstein.grindvik@muybridge.com>
This commit is contained in:
Torstein Grindvik 2023-10-20 16:43:16 +02:00 committed by GitHub
parent 4e28fa255d
commit 7132404b38
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
crates/bevy_asset/src/lib.rs
View File

@ -243,6 +243,9 @@ pub trait AssetApp {
/// Registers the given `processor` in the [`App`]'s [`AssetProcessor`]. /// Registers the given `processor` in the [`App`]'s [`AssetProcessor`].
fn register_asset_processor<P: Process>(&mut self, processor: P) -> &mut Self; fn register_asset_processor<P: Process>(&mut self, processor: P) -> &mut Self;
/// Registers the given [`AssetSourceBuilder`] with the given `id`. /// Registers the given [`AssetSourceBuilder`] with the given `id`.
///
/// Note that asset sources must be registered before adding [`AssetPlugin`] to your application,
/// since registered asset sources are built at that point and not after.
fn register_asset_source( fn register_asset_source(
&mut self, &mut self,
id: impl Into<AssetSourceId<'static>>, id: impl Into<AssetSourceId<'static>>,