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

Add note on ordering to AssetServerSettings docs. (#5706)

Browse Source 
# Objective

It's not obvious that the `AssetServerSettings` resource must be added before the `AssetPlugin`.

## Solution

Add a doc comment to this effect.
This commit is contained in:
Robin KAY 2022-08-30 02:40:18 +00:00
parent d346274e32
commit 9dd5b5354f
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -64,7 +64,9 @@ pub enum AssetStage {
#[derive(Default)] #[derive(Default)]
pub struct AssetPlugin; pub struct AssetPlugin;
/// [`AssetServer`] settings. /// Settings for the [`AssetServer`].
///
/// This resource must be added before the [`AssetPlugin`] or `DefaultPlugins` to take effect.
#[derive(Resource)] #[derive(Resource)]
pub struct AssetServerSettings { pub struct AssetServerSettings {
/// The base folder where assets are loaded from, relative to the executable. /// The base folder where assets are loaded from, relative to the executable.