Struct EntityMutExcept

pub struct EntityMutExcept<'w, B>
where
    B: Bundle,
{ /* private fields */ }

Provides mutable access to all components of an entity, with the exception of an explicit set.

This is a rather niche type that should only be used if you need access to all components of an entity, while still allowing you to consult other queries that might match entities that this query also matches. If you don’t need access to all components, prefer a standard query with a crate::query::Without filter.

Implementations

impl<'w, B> EntityMutExcept<'w, B>

where B: Bundle,

pub fn id(&self) -> Entity

Returns the ID of the current entity.

pub fn reborrow(&mut self) -> EntityMutExcept<'_, B>

Returns a new instance with a shorter lifetime.

This is useful if you have &mut EntityMutExcept, but you need EntityMutExcept.

pub fn as_readonly(&self) -> EntityRefExcept<'_, B>

Gets read-only access to all of the entity’s components, except for the ones in CL.

pub fn get<C>(&self) -> Option<&C>

where C: Component,

Gets access to the component of type C for the current entity. Returns None if the component doesn’t have a component of that type or if the type is one of the excluded components.

pub fn get_ref<C>(&self) -> Option<Ref<'_, C>>

where C: Component,

Gets access to the component of type C for the current entity, including change detection information. Returns None if the component doesn’t have a component of that type or if the type is one of the excluded components.

pub fn get_mut<C>(&mut self) -> Option<Mut<'_, C>>

where C: Component<Mutability = Mutable>,

Gets mutable access to the component of type C for the current entity. Returns None if the component doesn’t have a component of that type or if the type is one of the excluded components.

pub fn spawned_by(&self) -> MaybeLocation

Returns the source code location from which this entity has been spawned.

pub fn contains<T: Component>(&self) -> bool

Returns true if the current entity has a component of type T. Otherwise, this returns false.

Notes

If you do not know the concrete type of a component, consider using Self::contains_id or Self::contains_type_id.

pub fn contains_id(&self, component_id: ComponentId) -> bool

Returns true if the current entity has a component identified by component_id. Otherwise, this returns false.

Notes

• If you know the concrete type of the component, you should prefer Self::contains.
• If you know the component’s TypeId but not its ComponentId, consider using Self::contains_type_id.

pub fn contains_type_id(&self, type_id: TypeId) -> bool

Returns true if the current entity has a component with the type identified by type_id. Otherwise, this returns false.

Notes

• If you know the concrete type of the component, you should prefer Self::contains.
• If you have a ComponentId instead of a TypeId, consider using Self::contains_id.

pub fn get_by_id(&'w self, component_id: ComponentId) -> Option<Ptr<'w>>

Gets the component of the given ComponentId from the entity.

You should prefer to use the typed API Self::get where possible and only use this in cases where the actual component types are not known at compile time.

Unlike EntityMutExcept::get, this returns a raw pointer to the component, which is only valid while the EntityMutExcept is alive.

pub fn get_mut_by_id<F: DynamicComponentFetch>( &mut self, component_id: ComponentId, ) -> Option<MutUntyped<'_>>

Gets a MutUntyped of the component of the given ComponentId from the entity.

You should prefer to use the typed API Self::get_mut where possible and only use this in cases where the actual component types are not known at compile time.

Unlike EntityMutExcept::get_mut, this returns a raw pointer to the component, which is only valid while the EntityMutExcept is alive.

Trait Implementations

impl<B: Bundle> ContainsEntity for EntityMutExcept<'_, B>

fn entity(&self) -> Entity

Returns the contained entity.

impl<'a, B> From<&'a EntityMutExcept<'_, B>> for EntityRefExcept<'a, B>

where B: Bundle,

fn from(entity: &'a EntityMutExcept<'_, B>) -> Self

Converts to this type from the input type.

impl<'a, B: Bundle> From<&'a EntityMutExcept<'_, B>> for FilteredEntityMut<'a>

fn from(value: &'a EntityMutExcept<'_, B>) -> Self

Converts to this type from the input type.

impl<B: Bundle> Hash for EntityMutExcept<'_, B>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<B: Bundle> Ord for EntityMutExcept<'_, B>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<B: Bundle> PartialEq for EntityMutExcept<'_, B>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<B: Bundle> PartialOrd for EntityMutExcept<'_, B>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

EntityMutExcept’s comparison trait implementations match the underlying Entity, and cannot discern between different worlds.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, B> QueryData for EntityMutExcept<'a, B>

where B: Bundle,

SAFETY: All accesses that EntityRefExcept provides are also accesses that EntityMutExcept provides.

const IS_READ_ONLY: bool = false

True if this query is read-only and may not perform mutable access.

type ReadOnly = EntityRefExcept<'a, B>

The read-only variant of this QueryData, which satisfies the ReadOnlyQueryData trait.

type Item<'w> = EntityMutExcept<'w, B>

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.

fn shrink<'wlong: 'wshort, 'wshort>( item: Self::Item<'wlong>, ) -> Self::Item<'wshort>

This function manually implements subtyping for the query items.

unsafe fn fetch<'w>( world: &mut Self::Fetch<'w>, entity: Entity, _: TableRow, ) -> Self::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 an entity in the current archetype. Accesses components registered in WorldQuery::update_component_access.

impl<'a, B> WorldQuery for EntityMutExcept<'a, B>

where B: Bundle,

SAFETY: EntityMutExcept guards access to all components in the bundle B and populates Access values so that queries that conflict with this access are rejected.

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.

type Fetch<'w> = UnsafeWorldCell<'w>

Per archetype/table state retrieved by this WorldQuery to compute Self::Item for each entity.

type State = SmallVec<[ComponentId; 4]>

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.

fn shrink_fetch<'wlong: 'wshort, 'wshort>( fetch: Self::Fetch<'wlong>, ) -> Self::Fetch<'wshort>

This function manually implements subtyping for the query fetches.

unsafe fn init_fetch<'w>( world: UnsafeWorldCell<'w>, _: &Self::State, _: Tick, _: 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.

unsafe fn set_archetype<'w>( _: &mut Self::Fetch<'w>, _: &Self::State, _: &'w Archetype, _: &'w Table, )

Adjusts internal state to account for the next Archetype. This will always be called on archetypes that match this WorldQuery.

unsafe fn set_table<'w>(_: &mut Self::Fetch<'w>, _: &Self::State, _: &'w Table)

Adjusts internal state to account for the next Table. This will always be called on tables that match this WorldQuery.

fn update_component_access( state: &Self::State, filtered_access: &mut FilteredAccess<ComponentId>, )

Adds any component accesses used by this WorldQuery to access.

fn init_state(world: &mut World) -> Self::State

Creates and initializes a State for this WorldQuery type.

fn get_state(components: &Components) -> Option<Self::State>

Attempts to initialize a State for this WorldQuery type using read-only access to Components.

fn matches_component_set( _: &Self::State, _: &impl Fn(ComponentId) -> bool, ) -> bool

Returns true if this query matches a set of components. Otherwise, returns false.

fn set_access(_state: &mut Self::State, _access: &FilteredAccess<ComponentId>)

Sets available accesses for implementors with dynamic access such as FilteredEntityRef or FilteredEntityMut.

impl<B: Bundle> EntityEquivalent for EntityMutExcept<'_, B>

impl<B: Bundle> Eq for EntityMutExcept<'_, B>