Struct PluginGroupBuilder 

pub struct PluginGroupBuilder { /* private fields */ }

Facilitates the creation and configuration of a PluginGroup.

Provides a build ordering to ensure that Plugins which produce/require a Resource are built before/after dependent/depending Plugins. Plugins inside the group can be disabled, enabled or reordered.

Implementations

impl PluginGroupBuilder

pub fn start<PG>() -> PluginGroupBuilder

where PG: PluginGroup,

Start a new builder for the PluginGroup.

Examples found in repository

examples/app/plugin_group.rs (line 31)

    fn build(self) -> PluginGroupBuilder {
        PluginGroupBuilder::start::<Self>()
            .add(PrintHelloPlugin)
            .add(PrintWorldPlugin)
    }

pub fn contains<T>(&self) -> bool

where T: Plugin,

Checks if the PluginGroupBuilder contains the given Plugin.

pub fn enabled<T>(&self) -> bool

where T: Plugin,

Returns true if the PluginGroupBuilder contains the given Plugin and it’s enabled.

pub fn set<T>(self, plugin: T) -> PluginGroupBuilder

where T: Plugin,

Sets the value of the given Plugin, if it exists.

Panics

Panics if the Plugin does not exist.

pub fn try_set<T>( self, plugin: T, ) -> Result<PluginGroupBuilder, (PluginGroupBuilder, T)>

where T: Plugin,

Tries to set the value of the given Plugin, if it exists.

If the given plugin doesn’t exist returns self and the passed in Plugin.

pub fn add<T>(self, plugin: T) -> PluginGroupBuilder

where T: Plugin,

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.

Examples found in repository

examples/app/plugin_group.rs (line 32)

    fn build(self) -> PluginGroupBuilder {
        PluginGroupBuilder::start::<Self>()
            .add(PrintHelloPlugin)
            .add(PrintWorldPlugin)
    }

pub fn try_add<T>( self, plugin: T, ) -> Result<PluginGroupBuilder, (PluginGroupBuilder, T)>

where T: Plugin,

Attempts to add the plugin Plugin at the end of this PluginGroupBuilder.

If the plugin was already in the group the addition fails.

pub fn add_group(self, group: impl PluginGroup) -> PluginGroupBuilder

Adds a PluginGroup at the end of this PluginGroupBuilder. If the plugin was already in the group, it is removed from its previous place.

pub fn add_before<Target>(self, plugin: impl Plugin) -> PluginGroupBuilder

where Target: Plugin,

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.

Panics

Panics if Target is not already in this PluginGroupBuilder.

pub fn try_add_before<Target, Insert>( self, plugin: Insert, ) -> Result<PluginGroupBuilder, (PluginGroupBuilder, Insert)>

where Target: Plugin, Insert: Plugin,

Adds a Plugin in this PluginGroupBuilder before the plugin of type Target.

If the plugin was already in the group the add fails. If there isn’t a plugin of type Target in the group the plugin we’re trying to insert is returned.

pub fn try_add_before_overwrite<Target, Insert>( self, plugin: Insert, ) -> Result<PluginGroupBuilder, (PluginGroupBuilder, Insert)>

where Target: Plugin, Insert: Plugin,

Adds a Plugin in this PluginGroupBuilder before the plugin of type Target.

If the plugin was already in the group, it is removed from its previous places. If there isn’t a plugin of type Target in the group the plugin we’re trying to insert is returned.

pub fn add_after<Target>(self, plugin: impl Plugin) -> PluginGroupBuilder

where Target: Plugin,

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.

Panics

Panics if Target is not already in this PluginGroupBuilder.

pub fn try_add_after<Target, Insert>( self, plugin: Insert, ) -> Result<PluginGroupBuilder, (PluginGroupBuilder, Insert)>

where Target: Plugin, Insert: Plugin,

Adds a Plugin in this PluginGroupBuilder after the plugin of type Target.

If the plugin was already in the group the add fails. If there isn’t a plugin of type Target in the group the plugin we’re trying to insert is returned.

pub fn try_add_after_overwrite<Target, Insert>( self, plugin: Insert, ) -> Result<PluginGroupBuilder, (PluginGroupBuilder, Insert)>

where Target: Plugin, Insert: Plugin,

Adds a Plugin in this PluginGroupBuilder after the plugin of type Target.

If the plugin was already in the group, it is removed from its previous places. If there isn’t a plugin of type Target in the group the plugin we’re trying to insert is returned.

pub fn enable<T>(self) -> PluginGroupBuilder

where T: Plugin,

Enables a Plugin.

Plugins 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.

pub fn disable<T>(self) -> PluginGroupBuilder

where T: Plugin,

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.

Examples found in repository

examples/2d/mesh2d_repeated_texture.rs (line 20)

fn main() {
    App::new()
        .add_plugins(DefaultPlugins.build().disable::<AudioPlugin>())
        .add_systems(Startup, setup)
        .run();
}

examples/app/headless.rs (line 42)

fn main() {
    if cfg!(feature = "bevy_window") {
        println!("This example is running with the bevy_window feature enabled and will not run headless.");
        println!("Disable the default features and rerun the example to run headless.");
        println!("To do so, run:");
        println!();
        println!("    cargo run --example headless --no-default-features --features bevy_log");
        return;
    }

    // This app runs once
    App::new()
        .add_plugins(DefaultPlugins.set(ScheduleRunnerPlugin::run_once()))
        .add_systems(Update, hello_world_system)
        .run();

    // This app loops forever at 60 fps
    App::new()
        .add_plugins(
            DefaultPlugins
                .set(ScheduleRunnerPlugin::run_loop(Duration::from_secs_f64(
                    1.0 / 60.0,
                )))
                // The log and ctrl+c plugin can only be registered once globally,
                // which means we need to disable it here, because it was already registered with the
                // app that runs once.
                .disable::<LogPlugin>(),
        )
        .add_systems(Update, counter)
        .run();
}

pub fn finish(self, app: &mut App)

Consumes the PluginGroupBuilder and builds the contained Plugins in the order specified.

Panics

Panics if one of the plugin in the group was already added to the application.

Trait Implementations

impl PluginGroup for PluginGroupBuilder

fn build(self) -> PluginGroupBuilder

Configures the Plugins that are to be added.

fn name() -> String

Configures a name for the PluginGroup which is primarily used for debugging.

fn set<T>(self, plugin: T) -> PluginGroupBuilder

where T: Plugin,

Sets the value of the given Plugin, if it exists