Struct SyncComponentPlugin

pub struct SyncComponentPlugin<C: Component>(/* private fields */);

Plugin that registers a component for automatic sync to the render world. See SyncWorldPlugin for more information.

This plugin is automatically added by ExtractComponentPlugin, and only needs to be added for manual extraction implementations.

Implementation details

It adds SyncToRenderWorld as a required component to make the SyncWorldPlugin aware of the component, and handles cleanup of the component in the render world when it is removed from an entity.

Warning

When the component is removed from the main world entity, all components are removed from the entity in the render world. This is done in order to handle components with custom extraction logic and derived state.

Trait Implementations

impl<C: Component> Default for SyncComponentPlugin<C>

fn default() -> Self

Returns the “default value” for a type.

impl<C: Component> Plugin for SyncComponentPlugin<C>

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.