Struct BehaviorRefItem

pub struct BehaviorRefItem<'__w, T: Behavior> { /* private fields */ }

Automatically generated WorldQuery item type for BehaviorRef, returned when iterating over query results.

Implementations

impl<T: Behavior> BehaviorRefItem<'_, T>

pub fn current(&self) -> &T

Returns the current Behavior state.

pub fn index(&self) -> BehaviorIndex

Returns the BehaviorIndex associated with the current Behavior state.

pub fn has_index(&self, index: BehaviorIndex) -> bool

Returns true if the given BehaviorIndex matches a state in this Behavior stack.

pub fn previous(&self) -> Option<&T>

Returns the previous Behavior state in the stack.

Usage

Note that this is NOT the previously active state. Instead, this is the previous state which was active before the current one was started.

To access the previously active state, handle Stop instead.

pub fn iter(&self) -> impl Iterator<Item = &T> + '_

Returns an iterator over all Behavior states in the stack, including the current one.

The iterator is ordered from the initial behavior (index = 0) to the current one.

pub fn has_transition(&self) -> bool

Returns true if there is any pending Transition for this Behavior.

Usage

By design, only one transition is allowed per transition cycle.

The only exception to this rule is if the behavior is interrupted or reset where multiple states may be stopped within a single cycle.

If a transition is requested while another is pending, it would be overriden. The transition helper methods start, interrupt_start, stop and reset all trigger a warning in this case.

Because of this, this method is useful to avoid unintentional transition overrides.

pub fn has_sequence(&self) -> bool

Returns true if there is any TransitionSequence running on this Behavior.

This is useful to allow transition sequences to finish before starting a new behavior.

Trait Implementations

impl<T: Behavior> AsRef<T> for BehaviorRefItem<'_, T>

fn as_ref(&self) -> &T

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

impl<T: Behavior> Deref for BehaviorRefItem<'_, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Behavior> DetectChanges for BehaviorRefItem<'_, 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: Behavior> Index<BehaviorIndex> for BehaviorRefItem<'_, T>

type Output = T

The returned type after indexing.

fn index(&self, BehaviorIndex: BehaviorIndex) -> &Self::Output

Performs the indexing (container[index]) operation.