Struct extol_sprite_layer::SpriteLayerPlugin

pub struct SpriteLayerPlugin<Layer> { /* private fields */ }

This plugin adjusts your entities’ transforms so that their z-coordinates are sorted in the proper order, where the order is specified by the Layer component. Layers propagate to children (including through entities with no )

Layers propagate to children, including ‘through’ entities with no GlobalTransform.

If you need to know the z-coordinate, you can read it out of the GlobalTransform after the [SpriteLayer::SetZCoordinates] set has run.

In general you should only instantiate this plugin with a single type you use throughout your program.

By default your sprites will also be y-sorted. If you don’t need this, replace the SpriteLayerOptions like so:

app.insert_resource(SpriteLayerOptions { y_sort: false });

Trait Implementations

impl<Layer> Default for SpriteLayerPlugin<Layer>

fn default() -> Self

Returns the “default value” for a type.

impl<Layer: LayerIndex> Plugin for SpriteLayerPlugin<Layer>

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.