Struct BehaviorRef

pub struct BehaviorRef<T: Behavior> { /* private fields */ }

Query data for a Behavior.

Usage

This provides a read-only reference to the current behavior state and all previous states in the stack.

Additionally, it provides methods to check for pending transitions (has_transition), active transition sequences (has_sequence) and the current behavior index (index).

Implementations

impl<T: Behavior> BehaviorRef<T>

pub fn from_entity(entity: EntityRef<'_>) -> Option<BehaviorRefItem<'_, T>>

Creates a new BehaviorRef item from an EntityRef.

Trait Implementations

impl<T: Behavior> QueryData for BehaviorRef<T>

SAFETY: we assert fields are readonly below

unsafe fn fetch<'__w>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _entity: Entity, _table_row: TableRow, ) -> Self::Item<'__w>

SAFETY: we call fetch for each member that implements Fetch.

const IS_READ_ONLY: bool = true

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

type ReadOnly = BehaviorRef<T>

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

type Item<'__w> = BehaviorRefItem<'__w, 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.

impl<T: Behavior> WorldQuery for BehaviorRef<T>

unsafe fn set_archetype<'__w>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _state: &Self::State, _archetype: &'__w Archetype, _table: &'__w Table, )

SAFETY: we call set_archetype for each member that implements Fetch

unsafe fn set_table<'__w>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _state: &Self::State, _table: &'__w Table, )

SAFETY: we call set_table for each member that implements Fetch

const IS_DENSE: bool

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

type Fetch<'__w> = BehaviorRefFetch<'__w, T>

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

type State = BehaviorRefState<T>

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: <BehaviorRef<T> as WorldQuery>::Fetch<'__wlong>, ) -> <BehaviorRef<T> as WorldQuery>::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 as WorldQuery>::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.

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) -> BehaviorRefState<T>

Creates and initializes a State for this WorldQuery type.

fn get_state(components: &Components) -> Option<BehaviorRefState<T>>

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: Behavior> ReadOnlyQueryData for BehaviorRef<T>

SAFETY: we assert fields are readonly below