Struct ambient_api::ecs::ChangeQuery

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

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> ChangeQuery<Components>

where Components: ComponentsTuple + Copy + Clone + 'static,

pub fn requires(self, requires: impl ComponentsTuple) -> ChangeQuery<Components>

The entities must include the components in requires.

pub fn excludes(self, excludes: impl ComponentsTuple) -> ChangeQuery<Components>

The entities must not include the components in exclude.

pub fn track_change( self, changes: impl ComponentsTuple ) -> ChangeQuery<Components>

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>( self, callback: impl FnMut(Vec<(EntityId, <Components as ComponentsTuple>::Data)>) -> R + 'static ) -> Listener

where R: CallbackReturn,

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