Struct bevy_embasset::EmbassetPlugin

pub struct EmbassetPlugin<F> { /* private fields */ }

Bevy plugin that will insert EmbassetIo instead of the default AssetServer added by the AssetPlugin.

Examples

If you are using the DefaultPlugins group from Bevy, it can be added a couple of different ways.

Add Embasset Plugin

Without DefaultPlugins from Bevy, it’s a simple matter of adding the plugin:

 App::new().add_plugin(EmbassetPlugin::new(add_embasset_assets));

If however, DefaultPlugins are used, bevy inserts its AssetPlugin which causes a little extra work in order to add the plugin:

 App::new().add_embasset_plugin(add_embasset_assets);

Or a little more manually:

 App::new().add_plugins_with(DefaultPlugins, |group| {
     group.add_before::<AssetPlugin, _>(EmbassetPlugin::new(add_embasset_assets))
 });

Configure the plugin

The add_embasset_assets function from above can be generated from a build script (build.rs):

bevy_embasset::include_all_assets(
 &Path::new(&env::var("CARGO_MANIFEST_DIR").unwrap()).join("assets")
);

and includeded in the source:

include!(concat!(env!("OUT_DIR"), "/add_embasset_assets.rs"));

Alternatively, the add_embasset_assets can be created manually, gaining the ultimate flexibility:

fn add_embasset_assets(io: &mut EmbassetIo){
    // add assets manually...
    io.add_embedded_asset(Path::new("dummy"), include_bytes!("../assets/.keepme"));

    // or add other custom, AssetIo - for handling specific paths...
    io.add_handler(AssetIoAlternative::new("dummy://", DummyAssetIo).fallback_on_err());
}

To use the build script, the build feature needs to be enabled when building it:

[build-dependencies]
bevy-embasset = { version = "*", features = ["build"] }

Implementations

impl<F> EmbassetPlugin<F> where
    F: Fn(&mut EmbassetIo) + Send + Sync + 'static, 

pub fn new(asset_initializer: F) -> Self

Create a new instance of the plugin.

Trait Implementations

impl<F: Debug> Debug for EmbassetPlugin<F>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<F> Plugin for EmbassetPlugin<F> where
    F: Fn(&mut EmbassetIo) + Send + Sync + 'static, 

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

Configures the [App] to which this plugin is added.

fn name(&self) -> &str

Configures a name for the [Plugin] which is primarily used for debugging.