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

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§

source§

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

source

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

The entities must include the components in requires.

source

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

The entities must not include the components in exclude.

source

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.

source

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

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

Auto Trait Implementations§

§

impl<Components> RefUnwindSafe for ChangeQuery<Components>where Components: RefUnwindSafe,

§

impl<Components> Send for ChangeQuery<Components>where Components: Send,

§

impl<Components> Sync for ChangeQuery<Components>where Components: Sync,

§

impl<Components> Unpin for ChangeQuery<Components>where Components: Unpin,

§

impl<Components> UnwindSafe for ChangeQuery<Components>where Components: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> AsAny for Twhere T: Any,

§

fn as_any(&self) -> &(dyn Any + 'static)

§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

§

fn type_name(&self) -> &'static str

Gets the type name of self
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for Twhere T: AsAny + ?Sized,

§

fn is<T>(&self) -> boolwhere T: AsAny,

Returns true if the boxed type is the same as T. Read more
§

fn downcast_ref<T>(&self) -> Option<&T>where T: AsAny,

Forward to the method defined on the type Any.
§

fn downcast_mut<T>(&mut self) -> Option<&mut T>where T: AsAny,

Forward to the method defined on the type Any.
source§

impl<T> ElementComponentName for T

source§

fn element_component_name(&self) -> &'static str

Returns the name of the type implementing ElementComponent.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more