Struct YoleckEntityUpgradingPlugin

pub struct YoleckEntityUpgradingPlugin {
    pub app_format_version: usize,
}

Support upgrading of entities when the layout of the Yoleck entities and components change.

app.add_plugins(YoleckEntityUpgradingPlugin {
    app_format_version: 5,
});

// The newest upgrade, from 4 to 5
app.add_yoleck_entity_upgrade_for(5, "Foo", |data| {
    let mut old_data = data.as_object_mut().unwrap().remove("OldFooComponent").unwrap();
    data["NewFooComponent"] = old_data;
});

// Some older upgrade, from 2 to 3
app.add_yoleck_entity_upgrade(3, |_type_name, data| {
    if let Some(component_data) = data.get_mut("Bar") {
        component_data["some_new_field"] = 42.into();
    }
});

Fields

app_format_version: usize

The current version of the app data.

If YoleckEntityUpgradingPlugin is not added, the current version is considered 0 (“unversioned”)

Trait Implementations

impl Plugin for YoleckEntityUpgradingPlugin

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.