From 9dd5b5354f2d0b13c5a88b7d6875d491ca82c355 Mon Sep 17 00:00:00 2001 From: Robin KAY Date: Tue, 30 Aug 2022 02:40:18 +0000 Subject: [PATCH] Add note on ordering to AssetServerSettings docs. (#5706) # Objective It's not obvious that the `AssetServerSettings` resource must be added before the `AssetPlugin`. ## Solution Add a doc comment to this effect. --- crates/bevy_asset/src/lib.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/crates/bevy_asset/src/lib.rs b/crates/bevy_asset/src/lib.rs index 4a8d37c27a..f57e2d0123 100644 --- a/crates/bevy_asset/src/lib.rs +++ b/crates/bevy_asset/src/lib.rs @@ -64,7 +64,9 @@ pub enum AssetStage { #[derive(Default)] pub struct AssetPlugin; -/// [`AssetServer`] settings. +/// Settings for the [`AssetServer`]. +/// +/// This resource must be added before the [`AssetPlugin`] or `DefaultPlugins` to take effect. #[derive(Resource)] pub struct AssetServerSettings { /// The base folder where assets are loaded from, relative to the executable.