Struct moonshine_behavior::BehaviorMutItem

pub struct BehaviorMutItem<'__w, B: Behavior> { /* private fields */ }

Automatically generated [WorldQuery] item type for BehaviorMut, returned when iterating over query results.

Implementations

impl<B: Behavior> BehaviorMutItem<'_, B>

pub fn get(&self) -> &B

Returns a reference to the current Behavior.

pub fn get_mut(&mut self) -> &mut B

Returns a mutable reference to the current Behavior.

pub fn has_transition(&self) -> bool

Returns true if a Transition is currently in progress.

pub fn try_start(&mut self, next: B) -> Future<TransitionResult<B>>

Tries to start the given Behavior as the next one.

This only sets the behavior Transition, and does not immediately modify the behavior. The next behavior will only start if it is allowed to by the transition() system. Otherwise, the transition is ignored.

pub fn stop(&mut self)

Stops the current Behavior and tries to resume the previous one.

If the previous behavior is not resumable, the behavior before it is tried, and so on until a resumable behavior is found.

If the current behavior is the initial one, it does nothing.

pub fn reset(&mut self)

Stops the current Behavior and resumes the initial one.

If the current behavior is the initial one, it does nothing.

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

Returns a reference to the previous Behavior, if it exists.

pub fn memory(&self) -> &Memory<B>

Returns a reference to the Behavior Memory.

Trait Implementations

impl<B: Behavior> Borrow<B> for BehaviorMutItem<'_, B>

fn borrow(&self) -> &B

Immutably borrows from an owned value.

impl<B: Behavior> BorrowMut<B> for BehaviorMutItem<'_, B>

fn borrow_mut(&mut self) -> &mut B

Mutably borrows from an owned value.

impl<B: Behavior> Deref for BehaviorMutItem<'_, B>

type Target = B

The resulting type after dereferencing.

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

Dereferences the value.

impl<B: Behavior> DerefMut for BehaviorMutItem<'_, B>

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

Mutably dereferences the value.