Struct bevy_asset::AssetPlugin

pub struct AssetPlugin {
    pub asset_folder: String,
    pub watch_for_changes: Option<ChangeWatcher>,
}

Adds support for Assets to an App.

Assets are typed collections with change tracking, which are added as App Resources. Examples of assets: textures, sounds, 3d models, maps, scenes

Fields

asset_folder: String

The base folder where assets are loaded from, relative to the executable.

watch_for_changes: Option<ChangeWatcher>

Whether to watch for changes in asset files. Requires the filesystem_watcher feature, and cannot be supported on the wasm32 arch nor android os.

Implementations

impl AssetPlugin

pub fn create_platform_default_asset_io(&self) -> Box<dyn AssetIo>

Creates an instance of the platform’s default AssetIo.

This is useful when providing a custom AssetIo instance that needs to delegate to the default AssetIo for the platform.

Trait Implementations

impl Clone for AssetPlugin

fn clone(&self) -> AssetPlugin

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AssetPlugin

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

Formats the value using the given formatter.

impl Default for AssetPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for AssetPlugin

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 it’s setup? This can be useful for plugins that needs something asynchronous to happen before they can finish their setup, like renderer initialization. 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.