bevy/crates/bevy_app/src/plugin.rs

22 lines
780 B
Rust
Raw Normal View History

use crate::App;
2020-01-21 04:10:40 +00:00
use std::any::Any;
/// A collection of Bevy app logic and configuration.
///
/// Plugins configure an [`App`]. When an [`App`] registers a plugin,
/// the plugin's [`Plugin::build`] function is run.
2020-08-08 03:22:17 +00:00
pub trait Plugin: Any + Send + Sync {
/// Configures the [`App`] to which this plugin is added.
fn build(&self, app: &mut App);
/// Configures a name for the [`Plugin`] which is primarily used for debugging.
2020-04-05 21:12:14 +00:00
fn name(&self) -> &str {
std::any::type_name::<Self>()
2020-04-05 21:12:14 +00:00
}
2020-01-21 04:10:40 +00:00
}
/// A type representing an unsafe function that returns a mutable pointer to a [`Plugin`].
/// It is used for dynamically loading plugins.
///
/// See `bevy_dynamic_plugin/src/loader.rs#dynamically_load_plugin`.
2020-08-08 03:22:17 +00:00
pub type CreatePlugin = unsafe fn() -> *mut dyn Plugin;