Struct YoleckSyncWithEditorState

pub struct YoleckSyncWithEditorState<T>
where
    T: 'static + States + FreelyMutableState + Sync + Send + Debug + Clone + Eq + Hash,
{
    pub when_editor: T,
    pub when_game: T,
}

Sync the game’s state back and forth when the level editor enters and exits playtest mode.

Add this as a plugin. When using it, there is no need to initialize the state with add_state because YoleckSyncWithEditorState will initialize it and set its initial value to when_editor. This means that the state’s default value should be it’s initial value for non-editor mode (which is not necessarily when_game, because the game may start in a menu state or a loading state)

#[derive(States, Default, Debug, Clone, PartialEq, Eq, Hash)]
enum GameState {
    #[default]
    Loading,
    Game,
    Editor,
}

if executable_started_in_editor_mode {
    // These two plugins are needed for editor mode:
    app.add_plugins(EguiPlugin {
        enable_multipass_for_primary_context: true,
    });
    app.add_plugins(YoleckPluginForEditor);
    app.add_plugins(YoleckSyncWithEditorState {
        when_editor: GameState::Editor,
        when_game: GameState::Game,
    });
} else {
    // This plugin is needed for game mode:
    app.add_plugins(YoleckPluginForGame);

    app.init_state::<GameState>();
}

Fields

when_editor: T

when_game: T

Trait Implementations

impl<T> Plugin for YoleckSyncWithEditorState<T>

where T: 'static + States + FreelyMutableState + Sync + Send + Debug + Clone + Eq + Hash,

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.