Struct HierarchyPropagatePlugin 

pub struct HierarchyPropagatePlugin<C: Component + Clone + PartialEq, F: QueryFilter = (), R: Relationship = ChildOf> { /* private fields */ }

Plugin to automatically propagate a component value to all direct and transient relationship targets (e.g. bevy_ecs::hierarchy::Children) of entities with a Propagate component.

The plugin Will maintain the target component over hierarchy changes, adding or removing C when a relationship R (e.g. ChildOf) is added to or removed from a relationship tree with a Propagate<C> source, or if the Propagate<C> component is added, changed or removed.

Optionally you can include a query filter F to restrict the entities that are updated. Note that the filter is not rechecked dynamically: changes to the filter state will not be picked up until the Propagate component is touched, or the hierarchy is changed. All members of the tree between source and target must match the filter for propagation to reach a given target. Individual entities can be skipped or terminate the propagation with the PropagateOver and PropagateStop components.

The schedule can be configured via HierarchyPropagatePlugin::new. You should be sure to schedule your logic relative to this set: making changes that modify component values before this logic, and reading the propagated values after it.

Implementations

impl<C: Component + Clone + PartialEq, F: QueryFilter, R: Relationship> HierarchyPropagatePlugin<C, F, R>

pub fn new(schedule: impl ScheduleLabel) -> Self

Construct the plugin. The propagation systems will be placed in the specified schedule.

Trait Implementations

impl<C: Component + Clone + PartialEq, F: QueryFilter + 'static, R: Relationship> Plugin for HierarchyPropagatePlugin<C, F, R>

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.