pub trait Plugin: Downcast + Any + Send + Sync {
fn build(&self, app: &mut App);
fn name(&self) -> &str { ... }
fn is_unique(&self) -> bool { ... }
}
Expand description
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. By default, a plugin
can only be added once to an App
.
If the plugin may need to be added twice or more, the function is_unique()
should be overriden to return false
. Plugins are considered duplicate if they have the same
name()
. The default name()
implementation returns the type name, which means
generic plugins with different type parameters will not be considered duplicates.
Required Methods§
Provided Methods§
Implementations§
§impl dyn Plugin + 'static
impl dyn Plugin + 'static
pub fn is<__T>(&self) -> boolwhere
__T: Plugin,
pub fn is<__T>(&self) -> boolwhere
__T: Plugin,
Returns true if the trait object wraps an object of type __T
.
pub fn downcast<__T>(
self: Box<dyn Plugin + 'static, Global>
) -> Result<Box<__T, Global>, Box<dyn Plugin + 'static, Global>>where
__T: Plugin,
pub fn downcast<__T>(
self: Box<dyn Plugin + 'static, Global>
) -> Result<Box<__T, Global>, Box<dyn Plugin + 'static, Global>>where
__T: Plugin,
Returns a boxed object from a boxed trait object if the underlying object is of type
__T
. Returns the original boxed trait if it isn’t.
pub fn downcast_rc<__T>(
self: Rc<dyn Plugin + 'static>
) -> Result<Rc<__T>, Rc<dyn Plugin + 'static>>where
__T: Plugin,
pub fn downcast_rc<__T>(
self: Rc<dyn Plugin + 'static>
) -> Result<Rc<__T>, Rc<dyn Plugin + 'static>>where
__T: Plugin,
Returns an Rc
-ed object from an Rc
-ed trait object if the underlying object is of
type __T
. Returns the original Rc
-ed trait if it isn’t.
pub fn downcast_ref<__T>(&self) -> Option<&__T>where
__T: Plugin,
pub fn downcast_ref<__T>(&self) -> Option<&__T>where
__T: Plugin,
Returns a reference to the object within the trait object if it is of type __T
, or
None
if it isn’t.
pub fn downcast_mut<__T>(&mut self) -> Option<&mut __T>where
__T: Plugin,
pub fn downcast_mut<__T>(&mut self) -> Option<&mut __T>where
__T: Plugin,
Returns a mutable reference to the object within the trait object if it is of type
__T
, or None
if it isn’t.