Struct CiTestingPlugin

pub struct CiTestingPlugin;

Available on crate feature bevy_ci_testing only.

A plugin that instruments continuous integration testing by automatically executing user-defined actions.

This plugin reads a ron file specified with the CI_TESTING_CONFIG environmental variable (ci_testing_config.ron by default) and executes its specified actions. For a reference of the allowed configuration, see CiTestingConfig.

This plugin is included within DefaultPlugins and MinimalPlugins when the bevy_ci_testing feature is enabled. It is recommended to only used this plugin during testing (manual or automatic), and disable it during regular development and for production builds.

Trait Implementations

impl Default for CiTestingPlugin

fn default() -> CiTestingPlugin

Returns the “default value” for a type.

impl Plugin for CiTestingPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.