pub struct Spawned;
Expand description
A filter that only retains results the first time after the entity has been spawned.
A common use for this filter is one-time initialization.
To retain all results without filtering but still check whether they were spawned after the
system last ran, use SpawnDetails
instead.
Note that this includes entities that spawned before the first time this Query was run.
§Deferred
Note, that entity spawns issued with Commands
are visible only after deferred operations are applied, typically after the
system that queued them.
§Time complexity
Spawned
is not ArchetypeFilter
, which practically means that if query matches million
entities, Spawned
filter will iterate over all of them even if none of them were spawned.
For example, these two systems are roughly equivalent in terms of performance:
fn system1(query: Query<Entity, Spawned>) {
for entity in &query { /* entity spawned */ }
}
fn system2(query: Query<(Entity, SpawnDetails)>) {
for (entity, spawned) in &query {
if spawned.is_spawned() { /* entity spawned */ }
}
}
§Examples
fn print_spawning_entities(query: Query<&Name, Spawned>) {
for name in &query {
println!("Entity spawned: {:?}", name);
}
}
Trait Implementations§
Source§impl QueryFilter for Spawned
impl QueryFilter for Spawned
Source§const IS_ARCHETYPAL: bool = false
const IS_ARCHETYPAL: bool = false
Source§unsafe fn filter_fetch(
_state: &<Spawned as WorldQuery>::State,
fetch: &mut <Spawned as WorldQuery>::Fetch<'_>,
entity: Entity,
_table_row: TableRow,
) -> bool
unsafe fn filter_fetch( _state: &<Spawned as WorldQuery>::State, fetch: &mut <Spawned as WorldQuery>::Fetch<'_>, entity: Entity, _table_row: TableRow, ) -> bool
Source§impl WorldQuery for Spawned
impl WorldQuery for Spawned
Source§const IS_DENSE: bool = true
const IS_DENSE: bool = true
Source§type Fetch<'w> = SpawnedFetch<'w>
type Fetch<'w> = SpawnedFetch<'w>
WorldQuery
to compute Self::Item
for each entity.Source§type State = ()
type State = ()
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
.Source§fn shrink_fetch<'wlong, 'wshort>(
fetch: <Spawned as WorldQuery>::Fetch<'wlong>,
) -> <Spawned as WorldQuery>::Fetch<'wshort>where
'wlong: 'wshort,
fn shrink_fetch<'wlong, 'wshort>(
fetch: <Spawned as WorldQuery>::Fetch<'wlong>,
) -> <Spawned as WorldQuery>::Fetch<'wshort>where
'wlong: 'wshort,
Source§unsafe fn init_fetch<'w, 's>(
world: UnsafeWorldCell<'w>,
_state: &'s (),
last_run: Tick,
this_run: Tick,
) -> <Spawned as WorldQuery>::Fetch<'w>
unsafe fn init_fetch<'w, 's>( world: UnsafeWorldCell<'w>, _state: &'s (), last_run: Tick, this_run: Tick, ) -> <Spawned as WorldQuery>::Fetch<'w>
Self::Fetch
,
by combining data from the World
with the cached Self::State
.
Readonly accesses resources registered in WorldQuery::update_component_access
. Read moreSource§unsafe fn set_archetype<'w, 's>(
_fetch: &mut <Spawned as WorldQuery>::Fetch<'w>,
_state: &'s (),
_archetype: &'w Archetype,
_table: &'w Table,
)
unsafe fn set_archetype<'w, 's>( _fetch: &mut <Spawned as WorldQuery>::Fetch<'w>, _state: &'s (), _archetype: &'w Archetype, _table: &'w Table, )
Archetype
. This will always be called on
archetypes that match this WorldQuery
. Read moreSource§unsafe fn set_table<'w, 's>(
_fetch: &mut <Spawned as WorldQuery>::Fetch<'w>,
_state: &'s (),
_table: &'w Table,
)
unsafe fn set_table<'w, 's>( _fetch: &mut <Spawned as WorldQuery>::Fetch<'w>, _state: &'s (), _table: &'w Table, )
Table
. This will always be called on tables
that match this WorldQuery
. Read moreSource§fn update_component_access(_state: &(), _access: &mut FilteredAccess)
fn update_component_access(_state: &(), _access: &mut FilteredAccess)
Source§fn init_state(_world: &mut World)
fn init_state(_world: &mut World)
State
for this WorldQuery
type.Source§fn matches_component_set(
_state: &(),
_set_contains_id: &impl Fn(ComponentId) -> bool,
) -> bool
fn matches_component_set( _state: &(), _set_contains_id: &impl Fn(ComponentId) -> bool, ) -> bool
Auto Trait Implementations§
impl Freeze for Spawned
impl RefUnwindSafe for Spawned
impl Send for Spawned
impl Sync for Spawned
impl Unpin for Spawned
impl UnwindSafe for Spawned
Blanket Implementations§
Source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
Source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more