Struct InstanceMut

pub struct InstanceMut<'a, T: Component>(/* private fields */);

A QueryData item which represents a mutable reference to an Instance<T> and its associated Component.

This is analogous to a (Instance<T>, &mut T) query.

Usage

This type behaves similar like InstanceRef<T> but allows mutable access to its associated Component.

The main difference is that you cannot create an InstanceMut<T> from an EntityMut. See InstanceMut::from_entity for more details.

See InstanceRef<T> for more information and examples.

Implementations

impl<'a, T: Component> InstanceMut<'a, T>

pub fn from_entity(entity: &'a mut EntityWorldMut<'_>) -> Option<Self>

where T: Component<Mutability = Mutable>,

Creates a new InstanceMut<T> from an EntityWorldMut if it contains a given Component of type T.

Trait Implementations

impl<T: Component> AsMut<T> for InstanceMut<'_, T>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: Component> AsRef<Instance<T>> for InstanceMut<'_, T>

fn as_ref(&self) -> &Instance<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Component> AsRef<T> for InstanceMut<'_, T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Component> ContainsInstance<T> for InstanceMut<'_, T>

fn instance(&self) -> Instance<T>

Returns the associated Instance<T>.

fn entity(&self) -> Entity

Returns the Entity of the associated Instance<T>.

impl<T: Component> Deref for InstanceMut<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Component> DerefMut for InstanceMut<'_, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Component> DetectChanges for InstanceMut<'_, T>

fn is_added(&self) -> bool

Returns true if this value was added after the system last ran.

fn is_changed(&self) -> bool

Returns true if this value was added or mutably dereferenced either since the last time the system ran or, if the system never ran, since the beginning of the program.

fn last_changed(&self) -> Tick

Returns the change tick recording the time this data was most recently changed.

fn added(&self) -> Tick

Returns the change tick recording the time this data was added.

fn changed_by(&self) -> MaybeLocation

The location that last caused this to change.

impl<T: Component> DetectChangesMut for InstanceMut<'_, T>

type Inner = T

The type contained within this smart pointer

fn set_changed(&mut self)

Flags this value as having been changed.

fn set_last_changed(&mut self, last_changed: Tick)

Manually sets the change tick recording the time when this data was last mutated.

fn bypass_change_detection(&mut self) -> &mut Self::Inner

Manually bypasses change detection, allowing you to mutate the underlying value without updating the change tick.

fn set_added(&mut self)

Flags this value as having been added.

fn set_last_added(&mut self, last_added: Tick)

Manually sets the added tick recording the time when this data was last added.

fn set_if_neq(&mut self, value: Self::Inner) -> bool

where Self::Inner: Sized + PartialEq,

Overwrites this smart pointer with the given value, if and only if *self != value. Returns true if the value was overwritten, and returns false if it was not.

fn replace_if_neq(&mut self, value: Self::Inner) -> Option<Self::Inner>

where Self::Inner: Sized + PartialEq,

Overwrites this smart pointer with the given value, if and only if *self != value, returning the previous value if this occurs.

fn clone_from_if_neq<T>(&mut self, value: &T) -> bool

where T: ToOwned<Owned = Self::Inner> + ?Sized, Self::Inner: PartialEq<T>,

Overwrites this smart pointer with a clone of the given value, if and only if *self != value. Returns true if the value was overwritten, and returns false if it was not.

impl<T: Component> From<&InstanceMut<'_, T>> for Instance<T>

fn from(item: &InstanceMut<'_, T>) -> Self

Converts to this type from the input type.

impl<T: Component> From<InstanceMut<'_, T>> for Instance<T>

fn from(item: InstanceMut<'_, T>) -> Self

Converts to this type from the input type.

impl<T: Component> PartialEq for InstanceMut<'_, T>

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

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

const 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, T: Component<Mutability = Mutable>> QueryData for InstanceMut<'b, T>

const IS_READ_ONLY: bool = false

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

type ReadOnly = InstanceRef<'b, T>

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

type Item<'a> = InstanceMut<'a, T>

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>( fetch: &mut Self::Fetch<'w>, entity: Entity, table_row: 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<T: Component> WorldQuery for InstanceMut<'_, T>

const IS_DENSE: bool = <(Instance<T>, &T) as WorldQuery>::IS_DENSE

Returns true if (and only if) every table of every archetype matched by this fetch contains all of the matched components.

type Fetch<'w> = <(Instance<T>, &'static mut T) as WorldQuery>::Fetch<'w>

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

type State = <(Instance<T>, &'static mut T) as WorldQuery>::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.

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>, state: &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.

unsafe fn set_archetype<'w>( fetch: &mut Self::Fetch<'w>, state: &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.

unsafe fn set_table<'w>( fetch: &mut Self::Fetch<'w>, state: &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.

fn update_component_access( state: &Self::State, 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( state: &Self::State, set_contains_id: &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<T: Component> Eq for InstanceMut<'_, T>