1ba7429371
# Objective Provide a starting point for #3951, or a partial solution. Providing a few comment blocks to discuss, and hopefully find better one in the process. ## Solution Since I am pretty new to pretty much anything in this context, I figured I'd just start with a draft for some file level doc blocks. For some of them I found more relevant details (or at least things I considered interessting), for some others there is less. ## Changelog - Moved some existing comments from main() functions in the 2d examples to the file header level - Wrote some more comment blocks for most other 2d examples TODO: - [x] 2d/sprite_sheet, wasnt able to come up with something good yet - [x] all other example groups... Also: Please let me know if the commit style is okay, or to verbose. I could certainly squash these things, or add more details if needed. I also hope its okay to raise this PR this early, with just a few files changed. Took me long enough and I dont wanted to let it go to waste because I lost motivation to do the whole thing. Additionally I am somewhat uncertain over the style and contents of the commets. So let me know what you thing please.
53 lines
1.5 KiB
Rust
53 lines
1.5 KiB
Rust
//! Demonstrates the creation and registration of a custom plugin group.
|
|
//! [`PluginGroup`]s are a way to group sets of plugins that should be registered together.
|
|
|
|
use bevy::{app::PluginGroupBuilder, prelude::*};
|
|
|
|
fn main() {
|
|
App::new()
|
|
// Two PluginGroups that are included with bevy are DefaultPlugins and MinimalPlugins
|
|
.add_plugins(DefaultPlugins)
|
|
// Adding a plugin group adds all plugins in the group by default
|
|
.add_plugins(HelloWorldPlugins)
|
|
// You can also modify a PluginGroup (such as disabling plugins) like this:
|
|
// .add_plugins_with(HelloWorldPlugins, |group| {
|
|
// group
|
|
// .disable::<PrintWorldPlugin>()
|
|
// .add_before::<PrintHelloPlugin,
|
|
// _>(bevy::diagnostic::LogDiagnosticsPlugin::default()) })
|
|
.run();
|
|
}
|
|
|
|
/// A group of plugins that produce the "hello world" behavior
|
|
pub struct HelloWorldPlugins;
|
|
|
|
impl PluginGroup for HelloWorldPlugins {
|
|
fn build(&mut self, group: &mut PluginGroupBuilder) {
|
|
group.add(PrintHelloPlugin).add(PrintWorldPlugin);
|
|
}
|
|
}
|
|
|
|
pub struct PrintHelloPlugin;
|
|
|
|
impl Plugin for PrintHelloPlugin {
|
|
fn build(&self, app: &mut App) {
|
|
app.add_system(print_hello_system);
|
|
}
|
|
}
|
|
|
|
fn print_hello_system() {
|
|
info!("hello");
|
|
}
|
|
|
|
pub struct PrintWorldPlugin;
|
|
|
|
impl Plugin for PrintWorldPlugin {
|
|
fn build(&self, app: &mut App) {
|
|
app.add_system(print_world_system);
|
|
}
|
|
}
|
|
|
|
fn print_world_system() {
|
|
info!("world");
|
|
}
|