pub struct With<T>(_);
Expand description
Filter that selects entities with a component T
.
This can be used in a Query
if entities are required to have the
component T
but you don’t actually care about components value.
This is the negation of Without
.
Examples
fn compliment_entity_system(query: Query<&Name, With<IsBeautiful>>) {
for name in &query {
println!("{} is looking lovely today!", name.name);
}
}
Trait Implementations
impl<T> WorldQuery for With<T>where
T: Component,
impl<T> WorldQuery for With<T>where
T: Component,
type Fetch = ()
type Fetch = ()
Per archetype/table state used by this
WorldQuery
to fetch Self::Item
type Item = ()
type Item = ()
The item returned by this
WorldQuery
type ReadOnly = With<T>
type ReadOnly = With<T>
The read-only variant of this
WorldQuery
, which satisfies the ReadOnlyWorldQuery
trait.type State = ComponentId
type State = ComponentId
State used to construct a
Self::Fetch
. This will be cached inside QueryState
,
so it is best to move as much data / computation here as possible to reduce the cost of
constructing Self::Fetch
. Read morefn shrink<'wlong, 'wshort>(
_: <With<T> as WorldQuery>::Item<'wlong>
) -> <With<T> as WorldQuery>::Item<'wshort>where
'wlong: 'wshort,
fn shrink<'wlong, 'wshort>(
_: <With<T> as WorldQuery>::Item<'wlong>
) -> <With<T> as WorldQuery>::Item<'wshort>where
'wlong: 'wshort,
This function manually implements subtyping for the query items.
unsafe fn init_fetch(
_world: &World,
_state: &ComponentId,
_last_change_tick: u32,
_change_tick: u32
)
unsafe fn init_fetch(
_world: &World,
_state: &ComponentId,
_last_change_tick: u32,
_change_tick: u32
)
Creates a new instance of this fetch. Read more
unsafe fn clone_fetch<'w>(
_fetch: &<With<T> as WorldQuery>::Fetch<'w>
) -> <With<T> as WorldQuery>::Fetch<'w>
unsafe fn clone_fetch<'w>(
_fetch: &<With<T> as WorldQuery>::Fetch<'w>
) -> <With<T> as WorldQuery>::Fetch<'w>
While this function can be called for any query, it is always safe to call if
Self: ReadOnlyWorldQuery
holds. Read moreconst IS_DENSE: bool = {
match <T::Storage>::STORAGE_TYPE {
StorageType::Table => true,
StorageType::SparseSet => false,
}
}
const IS_DENSE: bool = { match <T::Storage>::STORAGE_TYPE { StorageType::Table => true, StorageType::SparseSet => false, } }
Returns true if (and only if) every table of every archetype matched by this fetch contains
all of the matched components. This is used to select a more efficient “table iterator”
for “dense” queries. If this returns true,
WorldQuery::set_table
must be used before
WorldQuery::fetch
can be called for iterators. If this returns false,
WorldQuery::set_archetype
must be used before WorldQuery::fetch
can be called for
iterators. Read moreconst IS_ARCHETYPAL: bool = true
const IS_ARCHETYPAL: bool = true
Returns true if (and only if) this Fetch relies strictly on archetypes to limit which
components are accessed by the Query. Read more
unsafe fn set_table(_fetch: &mut (), _state: &ComponentId, _table: &Table)
unsafe fn set_table(_fetch: &mut (), _state: &ComponentId, _table: &Table)
Adjusts internal state to account for the next
Table
. This will always be called on tables
that match this WorldQuery
. Read moreunsafe fn set_archetype(
_fetch: &mut (),
_state: &ComponentId,
_archetype: &Archetype,
_table: &Table
)
unsafe fn set_archetype(
_fetch: &mut (),
_state: &ComponentId,
_archetype: &Archetype,
_table: &Table
)
Adjusts internal state to account for the next
Archetype
. This will always be called on
archetypes that match this WorldQuery
. Read moreunsafe fn fetch<'w>(
_fetch: &mut <With<T> as WorldQuery>::Fetch<'w>,
_entity: Entity,
_table_row: usize
) -> <With<T> as WorldQuery>::Item<'w>
unsafe fn fetch<'w>(
_fetch: &mut <With<T> as WorldQuery>::Fetch<'w>,
_entity: Entity,
_table_row: usize
) -> <With<T> as WorldQuery>::Item<'w>
Fetch
Self::Item
for either the given entity
in the current Table
,
or for the given entity
in the current Archetype
. This must always be called after
WorldQuery::set_table
with a table_row
in the range of the current Table
or after
WorldQuery::set_archetype
with a entity
in the current archetype. Read morefn update_component_access(
_: &ComponentId,
access: &mut FilteredAccess<ComponentId>
)
fn update_archetype_component_access(
_state: &ComponentId,
_archetype: &Archetype,
_access: &mut Access<ArchetypeComponentId>
)
fn init_state(world: &mut World) -> ComponentId
fn matches_component_set(
_: &ComponentId,
set_contains_id: &impl Fn(ComponentId) -> bool
) -> bool
impl<T> ArchetypeFilter for With<T>
impl<T> ReadOnlyWorldQuery for With<T>where
T: Component,
Auto Trait Implementations
impl<T> RefUnwindSafe for With<T>where
T: RefUnwindSafe,
impl<T> Send for With<T>where
T: Send,
impl<T> Sync for With<T>where
T: Sync,
impl<T> Unpin for With<T>where
T: Unpin,
impl<T> UnwindSafe for With<T>where
T: UnwindSafe,
Blanket Implementations
impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
Return the
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist. Read moresourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read morefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read morefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read morefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more