Struct bevy_internal::core::prelude::DebugName
source · pub struct DebugName {
pub name: Option<&'static Name>,
pub entity: Entity,
}
Expand description
Convenient query for giving a human friendly name to an entity.
fn increment_score(mut scores: Query<(DebugName, &mut Score)>) {
for (name, mut score) in &mut scores {
score.0 += 1.0;
if score.0.is_nan() {
bevy_utils::tracing::error!("Score for {:?} is invalid", name);
}
}
}
Fields§
§name: Option<&'static Name>
A Name
that the entity might have that is displayed if available.
entity: Entity
The unique identifier of the entity as a fallback.
Trait Implementations§
source§impl QueryData for DebugName
impl QueryData for DebugName
SAFETY: we assert fields are readonly below
§type ReadOnly = DebugName
type ReadOnly = DebugName
The read-only variant of this
QueryData
, which satisfies the ReadOnlyQueryData
trait.source§impl WorldQuery for DebugName
impl WorldQuery for DebugName
source§unsafe fn set_archetype<'__w>(
_fetch: &mut <DebugName as WorldQuery>::Fetch<'__w>,
_state: &<DebugName as WorldQuery>::State,
_archetype: &'__w Archetype,
_table: &'__w Table
)
unsafe fn set_archetype<'__w>( _fetch: &mut <DebugName as WorldQuery>::Fetch<'__w>, _state: &<DebugName as WorldQuery>::State, _archetype: &'__w Archetype, _table: &'__w Table )
SAFETY: we call set_archetype
for each member that implements Fetch
source§unsafe fn set_table<'__w>(
_fetch: &mut <DebugName as WorldQuery>::Fetch<'__w>,
_state: &<DebugName as WorldQuery>::State,
_table: &'__w Table
)
unsafe fn set_table<'__w>( _fetch: &mut <DebugName as WorldQuery>::Fetch<'__w>, _state: &<DebugName as WorldQuery>::State, _table: &'__w Table )
SAFETY: we call set_table
for each member that implements Fetch
source§unsafe fn fetch<'__w>(
_fetch: &mut <DebugName as WorldQuery>::Fetch<'__w>,
_entity: Entity,
_table_row: TableRow
) -> <DebugName as WorldQuery>::Item<'__w>
unsafe fn fetch<'__w>( _fetch: &mut <DebugName as WorldQuery>::Fetch<'__w>, _entity: Entity, _table_row: TableRow ) -> <DebugName as WorldQuery>::Item<'__w>
SAFETY: we call fetch
for each member that implements Fetch
.
§type Item<'__w> = DebugNameItem<'__w>
type Item<'__w> = DebugNameItem<'__w>
The item returned by this
WorldQuery
For QueryData
this will be the item returned by the query.
For QueryFilter
this will be either ()
, or a bool
indicating whether the entity should be included
or a tuple of such things.§type Fetch<'__w> = DebugNameFetch<'__w>
type Fetch<'__w> = DebugNameFetch<'__w>
Per archetype/table state used by this
WorldQuery
to fetch Self::Item
§type State = DebugNameState
type State = DebugNameState
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<'__wlong, '__wshort>(
item: <DebugName as WorldQuery>::Item<'__wlong>
) -> <DebugName as WorldQuery>::Item<'__wshort>where
'__wlong: '__wshort,
fn shrink<'__wlong, '__wshort>(
item: <DebugName as WorldQuery>::Item<'__wlong>
) -> <DebugName as WorldQuery>::Item<'__wshort>where
'__wlong: '__wshort,
This function manually implements subtyping for the query items.
source§unsafe fn init_fetch<'__w>(
_world: UnsafeWorldCell<'__w>,
state: &<DebugName as WorldQuery>::State,
_last_run: Tick,
_this_run: Tick
) -> <DebugName as WorldQuery>::Fetch<'__w>
unsafe fn init_fetch<'__w>( _world: UnsafeWorldCell<'__w>, state: &<DebugName as WorldQuery>::State, _last_run: Tick, _this_run: Tick ) -> <DebugName as WorldQuery>::Fetch<'__w>
Creates a new instance of this fetch. Read more
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. 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.source§fn update_component_access(
state: &<DebugName as WorldQuery>::State,
_access: &mut FilteredAccess<ComponentId>
)
fn update_component_access( state: &<DebugName as WorldQuery>::State, _access: &mut FilteredAccess<ComponentId> )
Adds any component accesses used by this
WorldQuery
to access
.source§fn init_state(world: &mut World) -> DebugNameState
fn init_state(world: &mut World) -> DebugNameState
Creates and initializes a
State
for this WorldQuery
type.source§fn get_state(world: &World) -> Option<DebugNameState>
fn get_state(world: &World) -> Option<DebugNameState>
Attempts to initializes a
State
for this WorldQuery
type.source§fn matches_component_set(
state: &<DebugName as WorldQuery>::State,
_set_contains_id: &impl Fn(ComponentId) -> bool
) -> bool
fn matches_component_set( state: &<DebugName as WorldQuery>::State, _set_contains_id: &impl Fn(ComponentId) -> bool ) -> bool
Returns
true
if this query matches a set of components. Otherwise, returns false
.source§fn set_access(_state: &mut Self::State, _access: &FilteredAccess<ComponentId>)
fn set_access(_state: &mut Self::State, _access: &FilteredAccess<ComponentId>)
Sets available accesses for implementors with dynamic access such as
FilteredEntityRef
or FilteredEntityMut
. Read moreimpl ReadOnlyQueryData for DebugName
SAFETY: we assert fields are readonly below
Auto Trait Implementations§
impl Freeze for DebugName
impl RefUnwindSafe for DebugName
impl Send for DebugName
impl Sync for DebugName
impl Unpin for DebugName
impl UnwindSafe for DebugName
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> 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>
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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
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)
Convert
&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)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.