Struct game_library::settings::SettingsPlugin

pub struct SettingsPlugin {
    pub organization: String,
    pub application: String,
}

Plugin for settings which will register the settings resources and run the first_load system.

This also registers the SettingChanged event and a system to flush the settings to the [bevy_pkv::PkvStore] when the SettingChanged event is sent.

This will take care of initializing the [bevy_pkv::PkvStore] and loading the settings from disk. If you do not set the organization and application name, it will use the default organization and application name.

Fields

organization: String

The organization name. This is the directory that will be created on the disk, and contain a subdirectory for the application name, which then has the database file.

application: String

The application name.

Implementations

impl SettingsPlugin

pub fn with_application<S: ToString>(self, application: &S) -> Self

Set the application name.

pub fn with_organization<S: ToString>(self, organization: &S) -> Self

Set the organization name.

pub fn with_structure<S: ToString>( self, organization: &S, application: &S ) -> Self

Set the organization and application name.

Trait Implementations

impl Default for SettingsPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for SettingsPlugin

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.