694c06f3d0
# Objective Currently the `missing_docs` lint is allowed-by-default and enabled at crate level when their documentations is complete (see #3492). This PR proposes to inverse this logic by making `missing_docs` warn-by-default and mark crates with imcomplete docs allowed. ## Solution Makes `missing_docs` warn at workspace level and allowed at crate level when the docs is imcomplete.
62 lines
1.7 KiB
Rust
62 lines
1.7 KiB
Rust
//! Provides scene definition, instantiation and serialization/deserialization.
|
|
//!
|
|
//! Scenes are collections of entities and their associated components that can be
|
|
//! instantiated or removed from a world to allow composition. Scenes can be serialized/deserialized,
|
|
//! for example to save part of the world state to a file.
|
|
|
|
mod bundle;
|
|
mod dynamic_scene;
|
|
mod dynamic_scene_builder;
|
|
mod scene;
|
|
mod scene_filter;
|
|
mod scene_loader;
|
|
mod scene_spawner;
|
|
|
|
#[cfg(feature = "serialize")]
|
|
pub mod serde;
|
|
|
|
/// Rusty Object Notation, a crate used to serialize and deserialize bevy scenes.
|
|
pub use bevy_asset::ron;
|
|
|
|
use bevy_ecs::schedule::IntoSystemConfigs;
|
|
pub use bundle::*;
|
|
pub use dynamic_scene::*;
|
|
pub use dynamic_scene_builder::*;
|
|
pub use scene::*;
|
|
pub use scene_filter::*;
|
|
pub use scene_loader::*;
|
|
pub use scene_spawner::*;
|
|
|
|
#[allow(missing_docs)]
|
|
pub mod prelude {
|
|
#[doc(hidden)]
|
|
pub use crate::{
|
|
DynamicScene, DynamicSceneBuilder, DynamicSceneBundle, Scene, SceneBundle, SceneFilter,
|
|
SceneSpawner,
|
|
};
|
|
}
|
|
|
|
use bevy_app::prelude::*;
|
|
use bevy_asset::AssetApp;
|
|
|
|
/// Plugin that provides scene functionality to an [`App`].
|
|
#[derive(Default)]
|
|
pub struct ScenePlugin;
|
|
|
|
#[cfg(feature = "serialize")]
|
|
impl Plugin for ScenePlugin {
|
|
fn build(&self, app: &mut App) {
|
|
app.init_asset::<DynamicScene>()
|
|
.init_asset::<Scene>()
|
|
.init_asset_loader::<SceneLoader>()
|
|
.add_event::<SceneInstanceReady>()
|
|
.init_resource::<SceneSpawner>()
|
|
.add_systems(SpawnScene, (scene_spawner, scene_spawner_system).chain());
|
|
}
|
|
}
|
|
|
|
#[cfg(not(feature = "serialize"))]
|
|
impl Plugin for ScenePlugin {
|
|
fn build(&self, _: &mut App) {}
|
|
}
|