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.
52 lines
1.6 KiB
Rust
52 lines
1.6 KiB
Rust
//! Demonstrates the creation and registration of a custom plugin.
|
|
//!
|
|
//! Plugins are the foundation of Bevy. They are scoped sets of components, resources, and systems
|
|
//! that provide a specific piece of functionality (generally the smaller the scope, the better).
|
|
//! This example illustrates how to create a simple plugin that prints out a message.
|
|
|
|
use bevy::{prelude::*, utils::Duration};
|
|
|
|
fn main() {
|
|
App::new()
|
|
// plugins are registered as part of the "app building" process
|
|
.add_plugins((
|
|
DefaultPlugins,
|
|
PrintMessagePlugin {
|
|
wait_duration: Duration::from_secs(1),
|
|
message: "This is an example plugin".to_string(),
|
|
},
|
|
))
|
|
.run();
|
|
}
|
|
|
|
// This "print message plugin" prints a `message` every `wait_duration`
|
|
struct PrintMessagePlugin {
|
|
// Put your plugin configuration here
|
|
wait_duration: Duration,
|
|
message: String,
|
|
}
|
|
|
|
impl Plugin for PrintMessagePlugin {
|
|
// this is where we set up our plugin
|
|
fn build(&self, app: &mut App) {
|
|
let state = PrintMessageState {
|
|
message: self.message.clone(),
|
|
timer: Timer::new(self.wait_duration, TimerMode::Repeating),
|
|
};
|
|
app.insert_resource(state)
|
|
.add_systems(Update, print_message_system);
|
|
}
|
|
}
|
|
|
|
#[derive(Resource)]
|
|
struct PrintMessageState {
|
|
message: String,
|
|
timer: Timer,
|
|
}
|
|
|
|
fn print_message_system(mut state: ResMut<PrintMessageState>, time: Res<Time>) {
|
|
if state.timer.tick(time.delta()).finished() {
|
|
info!("{}", state.message);
|
|
}
|
|
}
|