Crate bevy_mod_check_filter

bevy_mod_check_filter

A query filter to allow Enabled-style marker components without losing the ergonomics of ZST-style marker component filtering!

Example

Without bevy_mod_check_filter:

#[derive(Component)]
struct Poisoned;

#[derive(Component)]
struct Name { name: &'static str }

fn all_poisoned(entities: Query<&Name, With<Poisoned>>) {
    // ...
}

With bevy_mod_check_filter:

#[derive(Component)]
struct Poisoned(pub bool);

impl std::ops::Deref for Poisoned {
    type Target = bool;
 
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

#[derive(Component)]
struct Name { name: &'static str }

fn all_poisoned(entities: Query<&Name, Check<Poisoned, Is<true>>>) {
    // ...
}

// OR with one of the provided type aliases:
fn find_poisoned(entities: Query<&Name, IsTrue<Poisoned>>) {
    // ...
}

License

All code in this repository is dual-licensed under either:

• MIT License (LICENSE-MIT file or http://opensource.org/licenses/MIT)
• Apache License, Version 2.0 (LICENSE-APACHE file or http://www.apache.org/licenses/LICENSE-2.0)

Structs

Check

Filter that selects entities with a component T, if the given Predicate is satisfied.

Is

A Predicate that checks if the provided T, coerced into a bool, equals the given VALUE.

Not

A Predicate that returns the negation of the given predicate.

Traits

Predicate

A trait for implementing versatile pre-filtering of Components.

Type Definitions

CheckNot

The negation of Check.

IsFalse

Query filter for checking if the component T is coercable as false.

IsTrue

Query filter for checking if the component T is coercable as true.

Derive Macros

IsVariant