Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust bevy_asset::AssetMode::Processed to take an Option<bool>th… #10481

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+33 −14
Open

Adjust bevy_asset::AssetMode::Processed to take an Option<bool>th… #10481

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a98c605
Adjust `bevy_asset::AssetMode::Processed` to take an `Option<bool>`th…
OvermindDL1 Nov 9, 2023
3755e3b
Adjusted implementation to match carts suggestion from #10481, exampl…
OvermindDL1 Nov 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 33 additions & 14 deletions crates/bevy_asset/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ pub struct AssetPlugin {
/// Most use cases should leave this set to [`None`] and enable a specific watcher feature such as `file_watcher` to enable
/// watching for dev-scenarios.
pub watch_for_changes_override: Option<bool>,
/// If set, will override the default "start asset processor" setting. By default "start asset processor" will be `false` unless
/// the `asset_processor` cargo feature is set in which case it will be true by default.
///
/// Most use cases should leave this set to [`None`] and enable the `asset_processor` cargo feature to enable on a per-build basis
/// unless the capability is needed to be toggleable at runtime.
pub start_asset_processor_override: Option<bool>,
/// The [`AssetMode`] to use for this server.
pub mode: AssetMode,
}
Expand All @@ -89,7 +95,7 @@ pub enum AssetMode {
///
/// When developing an app, you should enable the `asset_processor` cargo feature, which will run the asset processor at startup. This should generally
/// be used in combination with the `file_watcher` cargo feature, which enables hot-reloading of assets that have changed. When both features are enabled,
/// changes to "original/source assets" will be detected, the asset will be re-processed, and then the final processed asset will be hot-reloaded in the app.
/// changes to "original/source assets" will be detected, the asset will be re-processed, and then the final processed asset will be hot-reloaded in the app.
///
/// [`AssetMeta`]: crate::meta::AssetMeta
/// [`AssetSource`]: crate::io::AssetSource
Expand All @@ -104,6 +110,7 @@ impl Default for AssetPlugin {
file_path: Self::DEFAULT_UNPROCESSED_FILE_PATH.to_string(),
processed_file_path: Self::DEFAULT_PROCESSED_FILE_PATH.to_string(),
watch_for_changes_override: None,
start_asset_processor_override: None,
}
}
}
Expand Down Expand Up @@ -148,22 +155,34 @@ impl Plugin for AssetPlugin {
AssetMode::Processed => {
#[cfg(feature = "asset_processor")]
{
let mut builders = app.world.resource_mut::<AssetSourceBuilders>();
let processor = AssetProcessor::new(&mut builders);
let mut sources = builders.build_sources(false, watch);
sources.gate_on_processor(processor.data.clone());
// the main asset server shares loaders with the processor asset server
app.insert_resource(AssetServer::new_with_loaders(
sources,
processor.server().data.loaders.clone(),
AssetServerMode::Processed,
watch,
))
.insert_resource(processor)
.add_systems(bevy_app::Startup, AssetProcessor::start);
if self.start_asset_processor_override.unwrap_or(true) {
let mut builders = app.world.resource_mut::<AssetSourceBuilders>();
let processor = AssetProcessor::new(&mut builders);
let mut sources = builders.build_sources(false, watch);
sources.gate_on_processor(processor.data.clone());
// the main asset server shares loaders with the processor asset server
app.insert_resource(AssetServer::new_with_loaders(
sources,
processor.server().data.loaders.clone(),
AssetServerMode::Processed,
watch,
))
.insert_resource(processor)
.add_systems(bevy_app::Startup, AssetProcessor::start);
} else {
let mut builders = app.world.resource_mut::<AssetSourceBuilders>();
let sources = builders.build_sources(false, watch);
app.insert_resource(AssetServer::new(
sources,
AssetServerMode::Processed,
watch,
));
}
}
#[cfg(not(feature = "asset_processor"))]
{
// avoid unused warning as this configuration is unused when the `asset`processor is not compiled in
let _ = self.start_asset_processor_override;
let mut builders = app.world.resource_mut::<AssetSourceBuilders>();
let sources = builders.build_sources(false, watch);
app.insert_resource(AssetServer::new(
Expand Down