Struct bevy_file_dialog::FileDialog

pub struct FileDialog<'w, 's, 'a> { /* private fields */ }

File dialog for saving/loading files. You can further customize what can be saved/loaded and the initial state of dialog with its functions.

Implementations

impl<'w, 's, 'a> FileDialog<'w, 's, 'a>

pub fn pick_directory_path<T: PickDirectoryPath>(self)

Open pick directory dialog and send DialogDirectoryPicked<T> event. You can read this event with Bevy’s EventReader<DialogDirectoryPicked<T>>.

Does not exist in wasm32.

pub fn pick_multiple_directory_paths<T: PickDirectoryPath>(self)

Open pick multiple directories dialog and send DialogDirectoryPicked<T> for each selected directory path. You can get each path by reading every event received with with Bevy’s EventReader<DialogDirectoryPicked<T>>.

Does not exist in wasm32.

pub fn pick_file_path<T: PickFilePath>(self)

Open pick file dialog and send DialogFilePicked<T> event. You can read this event with Bevy’s EventReader<DialogFilePicked<T>>.

Does not exist in wasm32. If you want cross-platform solution, you need to use FileDialog::load_file, which does picking and loading in one step which is compatible with wasm.

pub fn pick_multiple_file_paths<T: PickDirectoryPath>(self)

Open pick multiple files dialog and send DialogFilePicked<T> for each selected file path. You can get each path by reading every event received with with Bevy’s EventReader<DialogFilePicked<T>>.

Does not exist in wasm32. If you want cross-platform solution, you need to use FileDialog::load_multiple_files, which does picking and loading in one step which is compatible with wasm.

impl<'w, 's, 'a> FileDialog<'w, 's, 'a>

pub fn add_filter( self, name: impl Into<String>, extensions: &[impl ToString] ) -> Self

Add file extension filter.

Takes in the name of the filter, and list of extensions

The name of the filter will be displayed on supported platforms:

• Windows
• Linux

On platforms that don’t support filter names, all filters will be merged into one filter

pub fn set_directory<P: AsRef<Path>>(self, path: P) -> Self

Set starting directory of the dialog. Supported platforms:

• Linux (GTK only)
• Windows
• Mac

pub fn set_file_name(self, file_name: impl Into<String>) -> Self

Set starting file name of the dialog. Supported platforms:

• Windows
• Linux
• Mac

pub fn set_title(self, title: impl Into<String>) -> Self

Set the title of the dialog. Supported platforms:

• Windows
• Linux
• Mac (Only below version 10.11)
• WASM32

pub fn save_file<T: SaveContents>(self, contents: Vec<u8>)

Open save file dialog and save the contents to that file. When file gets saved, the DialogFileSaved<T> gets sent. You can get read this event with Bevy’s EventReader<DialogFileSaved<T>> system param.

pub fn load_file<T: LoadContents>(self)

Open pick file dialog and load its contents. When file contents get loaded, the DialogFileLoaded<T> gets sent. You can read this event with Bevy’s EventReader<DialogFileLoaded<T>>.

pub fn load_multiple_files<T: LoadContents>(self)

Open pick file dialog for multiple files and load contents for all selected files. When file contents get loaded, the DialogFileLoaded<T> gets sent for each file. You can read each file by reading every event received with with Bevy’s EventReader<DialogFileLoaded<T>>.