Struct ambient_api_core::ecs::ChangeQuery

pub struct ChangeQuery<Components: ComponentsTuple + Copy + Clone + 'static>(/* private fields */);

A partially-built ECS query that calls a callback when entities containing components marked with Self::track_change have those components change.

This cannot be constructed without first going through UntrackedChangeQuery or change_query.

Implementations

impl<Components: ComponentsTuple + Copy + Clone + 'static> ChangeQuery<Components>

pub fn requires(self, requires: impl ComponentsTuple) -> Self

The entities must include the components in requires.

pub fn excludes(self, excludes: impl ComponentsTuple) -> Self

The entities must not include the components in exclude.

pub fn track_change(self, changes: impl ComponentsTuple) -> Self

The query will return results when these components change values.

Note that this does not implicitly requires the components; this allows you to track changes for entities that do not have all of the tracked components.

pub fn bind<R: CallbackReturn>( self, callback: impl FnMut(Vec<(EntityId, Components::Data)>) -> R + 'static ) -> Listener

Each time the components marked by Self::track_change change, the callback (fn) is called with the result of the query.