pub struct SpawnDetails { /* private fields */ }Expand description
The SpawnDetails query parameter fetches the Tick the entity was spawned at.
To evaluate whether the spawn happened since the last time the system ran, the system
param SystemChangeTick needs to be used.
If the query should filter for spawned entities instead, use the
Spawned query filter instead.
§Examples
fn print_spawn_details(query: Query<(Entity, SpawnDetails)>) {
for (entity, spawn_details) in &query {
if spawn_details.is_spawned() {
print!("new ");
}
print!(
"entity {:?} spawned at {:?}",
entity,
spawn_details.spawn_tick()
);
match spawn_details.spawned_by().into_option() {
Some(location) => println!(" by {:?}", location),
None => println!()
}
}
}
Implementations§
Source§impl SpawnDetails
impl SpawnDetails
Sourcepub fn is_spawned(self) -> bool
pub fn is_spawned(self) -> bool
Returns true if the entity spawned since the last time this system ran.
Otherwise, returns false.
Sourcepub fn spawn_tick(self) -> Tick
pub fn spawn_tick(self) -> Tick
Returns the Tick this entity spawned at.
Sourcepub fn spawned_by(self) -> MaybeLocation
pub fn spawned_by(self) -> MaybeLocation
Returns the source code location from which this entity has been spawned.
Trait Implementations§
Source§impl Clone for SpawnDetails
impl Clone for SpawnDetails
Source§fn clone(&self) -> SpawnDetails
fn clone(&self) -> SpawnDetails
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for SpawnDetails
impl Debug for SpawnDetails
Source§impl QueryData for SpawnDetails
impl QueryData for SpawnDetails
Source§const IS_READ_ONLY: bool = true
const IS_READ_ONLY: bool = true
True if this query is read-only and may not perform mutable access.
Source§type ReadOnly = SpawnDetails
type ReadOnly = SpawnDetails
The read-only variant of this
QueryData, which satisfies the ReadOnlyQueryData trait.Source§type Item<'w, 's> = SpawnDetails
type Item<'w, 's> = SpawnDetails
The item returned by this
WorldQuery
This will be the data retrieved by the query,
and is visible to the end user when calling e.g. Query<Self>::get.Source§fn shrink<'wlong: 'wshort, 'wshort, 's>(
item: Self::Item<'wlong, 's>,
) -> Self::Item<'wshort, 's>
fn shrink<'wlong: 'wshort, 'wshort, 's>( item: Self::Item<'wlong, 's>, ) -> Self::Item<'wshort, 's>
This function manually implements subtyping for the query items.
Source§unsafe fn fetch<'w, 's>(
_state: &'s Self::State,
fetch: &mut Self::Fetch<'w>,
entity: Entity,
_table_row: TableRow,
) -> Self::Item<'w, 's>
unsafe fn fetch<'w, 's>( _state: &'s Self::State, fetch: &mut Self::Fetch<'w>, entity: Entity, _table_row: TableRow, ) -> Self::Item<'w, 's>
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 an entity in the current archetype.
Accesses components registered in WorldQuery::update_component_access. Read moreSource§fn provide_extra_access(
_state: &mut Self::State,
_access: &mut Access,
_available_access: &Access,
)
fn provide_extra_access( _state: &mut Self::State, _access: &mut Access, _available_access: &Access, )
Offers additional access above what we requested in
update_component_access.
Implementations may add additional access that is a subset of available_access
and does not conflict with anything in access,
and must update access to include that access. Read moreSource§impl ReleaseStateQueryData for SpawnDetails
impl ReleaseStateQueryData for SpawnDetails
Source§fn release_state<'w>(item: Self::Item<'w, '_>) -> Self::Item<'w, 'static>
fn release_state<'w>(item: Self::Item<'w, '_>) -> Self::Item<'w, 'static>
Releases the borrow from the query state by converting an item to have a
'static state lifetime.Source§impl WorldQuery for SpawnDetails
impl WorldQuery for SpawnDetails
Source§const IS_DENSE: bool = true
const IS_DENSE: bool = true
Returns true if (and only if) every table of every archetype matched by this fetch contains
all of the matched components. Read more
Source§type Fetch<'w> = SpawnDetailsFetch<'w>
type Fetch<'w> = SpawnDetailsFetch<'w>
Per archetype/table state retrieved by this
WorldQuery to compute Self::Item for each entity.Source§type State = ()
type State = ()
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.Source§fn shrink_fetch<'wlong: 'wshort, 'wshort>(
fetch: Self::Fetch<'wlong>,
) -> Self::Fetch<'wshort>
fn shrink_fetch<'wlong: 'wshort, 'wshort>( fetch: Self::Fetch<'wlong>, ) -> Self::Fetch<'wshort>
This function manually implements subtyping for the query fetches.
Source§unsafe fn init_fetch<'w, 's>(
world: UnsafeWorldCell<'w>,
_state: &'s Self::State,
last_run: Tick,
this_run: Tick,
) -> Self::Fetch<'w>
unsafe fn init_fetch<'w, 's>( world: UnsafeWorldCell<'w>, _state: &'s Self::State, last_run: Tick, this_run: Tick, ) -> Self::Fetch<'w>
Creates a new instance of
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 Self::Fetch<'w>,
_state: &'s Self::State,
_archetype: &'w Archetype,
_table: &'w Table,
)
unsafe fn set_archetype<'w, 's>( _fetch: &mut Self::Fetch<'w>, _state: &'s Self::State, _archetype: &'w Archetype, _table: &'w Table, )
Adjusts internal state to account for the next
Archetype. This will always be called on
archetypes that match this WorldQuery. Read moreSource§unsafe fn set_table<'w, 's>(
_fetch: &mut Self::Fetch<'w>,
_state: &'s Self::State,
_table: &'w Table,
)
unsafe fn set_table<'w, 's>( _fetch: &mut Self::Fetch<'w>, _state: &'s Self::State, _table: &'w Table, )
Adjusts internal state to account for the next
Table. This will always be called on tables
that match this WorldQuery. Read moreSource§fn update_component_access(_state: &Self::State, _access: &mut FilteredAccess)
fn update_component_access(_state: &Self::State, _access: &mut FilteredAccess)
Source§fn init_state(_world: &mut World)
fn init_state(_world: &mut World)
Creates and initializes a
State for this WorldQuery type.Source§fn matches_component_set(
_state: &Self::State,
_set_contains_id: &impl Fn(ComponentId) -> bool,
) -> bool
fn matches_component_set( _state: &Self::State, _set_contains_id: &impl Fn(ComponentId) -> bool, ) -> bool
impl Copy for SpawnDetails
impl ReadOnlyQueryData for SpawnDetails
SAFETY: access is read only
Auto Trait Implementations§
impl Freeze for SpawnDetails
impl RefUnwindSafe for SpawnDetails
impl Send for SpawnDetails
impl Sync for SpawnDetails
impl Unpin for SpawnDetails
impl UnwindSafe for SpawnDetails
Blanket Implementations§
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
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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>
Converts
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>
Converts
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)
Converts
&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)
Converts
&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> 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> IntoResult<T> for T
impl<T> IntoResult<T> for T
Source§fn into_result(self) -> Result<T, RunSystemError>
fn into_result(self) -> Result<T, RunSystemError>
Converts this type into the system output type.
Source§impl<T> TypeData for T
impl<T> TypeData for T
Source§fn clone_type_data(&self) -> Box<dyn TypeData>
fn clone_type_data(&self) -> Box<dyn TypeData>
Creates a type-erased clone of this value.