Struct bevy_app::PluginGroupBuilder
source · pub struct PluginGroupBuilder { /* private fields */ }
Expand description
Facilitates the creation and configuration of a PluginGroup
.
Provides a build ordering to ensure that Plugin
s which produce/require a Resource
are built before/after dependent/depending Plugin
s. Plugin
s inside the group
can be disabled, enabled or reordered.
Implementations§
source§impl PluginGroupBuilder
impl PluginGroupBuilder
sourcepub fn start<PG: PluginGroup>() -> Self
pub fn start<PG: PluginGroup>() -> Self
Start a new builder for the PluginGroup
.
sourcepub fn add<T: Plugin>(self, plugin: T) -> Self
pub fn add<T: Plugin>(self, plugin: T) -> Self
Adds the plugin Plugin
at the end of this PluginGroupBuilder
. If the plugin was
already in the group, it is removed from its previous place.
sourcepub fn add_group(self, group: impl PluginGroup) -> Self
pub fn add_group(self, group: impl PluginGroup) -> Self
Adds a PluginGroup
at the end of this PluginGroupBuilder
. If the plugin was
already in the group, it is removed from its previous place.
sourcepub fn add_before<Target: Plugin, T: Plugin>(self, plugin: T) -> Self
pub fn add_before<Target: Plugin, T: Plugin>(self, plugin: T) -> Self
Adds a Plugin
in this PluginGroupBuilder
before the plugin of type Target
.
If the plugin was already the group, it is removed from its previous place. There must
be a plugin of type Target
in the group or it will panic.
sourcepub fn add_after<Target: Plugin, T: Plugin>(self, plugin: T) -> Self
pub fn add_after<Target: Plugin, T: Plugin>(self, plugin: T) -> Self
Adds a Plugin
in this PluginGroupBuilder
after the plugin of type Target
.
If the plugin was already the group, it is removed from its previous place. There must
be a plugin of type Target
in the group or it will panic.
sourcepub fn enable<T: Plugin>(self) -> Self
pub fn enable<T: Plugin>(self) -> Self
Enables a Plugin
.
Plugin
s within a PluginGroup
are enabled by default. This function is used to
opt back in to a Plugin
after disabling it. If there are no plugins
of type T
in this group, it will panic.
sourcepub fn disable<T: Plugin>(self) -> Self
pub fn disable<T: Plugin>(self) -> Self
Disables a Plugin
, preventing it from being added to the App
with the rest of the
PluginGroup
. The disabled Plugin
keeps its place in the PluginGroup
, so it can
still be used for ordering with add_before
or
add_after
, or it can be re-enabled. If there are no
plugins of type T
in this group, it will panic.
Trait Implementations§
source§impl PluginGroup for PluginGroupBuilder
impl PluginGroup for PluginGroupBuilder
source§fn build(self) -> PluginGroupBuilder
fn build(self) -> PluginGroupBuilder
Plugin
s that are to be added.source§fn name() -> String
fn name() -> String
PluginGroup
which is primarily used for debugging.Auto Trait Implementations§
impl Freeze for PluginGroupBuilder
impl !RefUnwindSafe for PluginGroupBuilder
impl Send for PluginGroupBuilder
impl Sync for PluginGroupBuilder
impl Unpin for PluginGroupBuilder
impl !UnwindSafe for PluginGroupBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.