Struct FileDialogPlugin

pub struct FileDialogPlugin(/* private fields */);

Add this plugin to Bevy App to use the FileDialog resource in your system to save/load files.

Implementations

impl FileDialogPlugin

pub fn with_pick_directory<T: PickDirectoryPath>(self) -> Self

Allow picking directory paths. This allows you to call FileDialog::pick_directory_path and FileDialog::pick_multiple_directory_paths on Commands. For each with_pick_directory you will receive DialogDirectoryPicked<T> in your systems when picking completes.

Does not exist in WASM32.

pub fn with_pick_file<T: PickFilePath>(self) -> Self

Allow picking file paths. This allows you to call FileDialog::pick_file_path and FileDialog::pick_multiple_file_paths on Commands. For each with_pick_file you will receive DialogFilePicked<T> in your systems when picking completes.

Does not exist in WASM32. If you want cross-platform solution for files, you need to use FileDialogPlugin::with_load_file, which allows picking and loading in one step which is compatible with wasm.

impl FileDialogPlugin

pub fn new() -> Self

Create new file dialog plugin. Do not forget to call at least one with_save_file, with_load_file or with_pick_directory on the plugin to allow you to save/load files and pick directories.

pub fn with_save_file<T: SaveContents>(self) -> Self

Allow saving file contents. This allows you to call dialog().save_file::<T>() on Commands. For each with_save_file you will receive DialogFileSaved<T> in your systems when save_file completes.

pub fn with_load_file<T: LoadContents>(self) -> Self

Allow loading file contents. This allows you to call dialog().load_file::<T>() on Commands. For each with_load_file you will receive DialogFileLoaded<T> in your systems when load_file completes.

Trait Implementations

impl Default for FileDialogPlugin

fn default() -> FileDialogPlugin

Returns the “default value” for a type.

impl Plugin for FileDialogPlugin

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.