Struct ActionEvents 

pub struct ActionEvents(/* private fields */);

Available on crate feature input_bei and (crate features input_bei or input_native or leafwing) only.

Bitset with events caused by state transitions of TriggerState.

During EnhancedInputSystems::Apply, events that correspond to bitflags will be triggered.

You can use this component directly in systems or react on corresponding events in observers.

Table of state transitions:

Last state	New state	Events
TriggerState::None	TriggerState::None	No events
TriggerState::None	TriggerState::Ongoing	Start + Ongoing
TriggerState::None	TriggerState::Fired	Start + Fire
TriggerState::Ongoing	TriggerState::None	Cancel
TriggerState::Ongoing	TriggerState::Ongoing	Ongoing
TriggerState::Ongoing	TriggerState::Fired	Fire
TriggerState::Fired	TriggerState::Fired	Fire
TriggerState::Fired	TriggerState::Ongoing	Ongoing
TriggerState::Fired	TriggerState::None	Complete

The meaning of each kind depends on the assigned InputConditions. The events are triggered in the action evaluation order.

Implementations

impl ActionEvents

pub const STARTED: ActionEvents = Self::START

👎Deprecated since 0.23.0:

Replaced by START

pub const FIRED: ActionEvents = Self::FIRE

👎Deprecated since 0.23.0:

Replaced by FIRE

pub const CANCELLED: ActionEvents = Self::CANCEL

👎Deprecated since 0.23.0:

Replaced by CANCEL

pub const COMPLETED: ActionEvents = Self::COMPLETE

👎Deprecated since 0.23.0:

Replaced by COMPLETE

impl ActionEvents

pub const START: ActionEvents

Corresponds to Start.

pub const ONGOING: ActionEvents

Corresponds to Ongoing.

pub const FIRE: ActionEvents

Corresponds to Fire.

pub const CANCEL: ActionEvents

Corresponds to Cancel.

pub const COMPLETE: ActionEvents

Corresponds to Complete.

impl ActionEvents

pub const fn empty() -> ActionEvents

Get a flags value with all bits unset.

pub const fn all() -> ActionEvents

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u8) -> Option<ActionEvents>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u8) -> ActionEvents

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> ActionEvents

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<ActionEvents>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: ActionEvents) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: ActionEvents) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: ActionEvents)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: ActionEvents)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: ActionEvents)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: ActionEvents, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: ActionEvents) -> ActionEvents

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: ActionEvents) -> ActionEvents

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: ActionEvents) -> ActionEvents

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: ActionEvents) -> ActionEvents

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> ActionEvents

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl ActionEvents

pub const fn iter(&self) -> Iter<ActionEvents>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<ActionEvents>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl ActionEvents

pub fn new(previous: TriggerState, current: TriggerState) -> ActionEvents

Creates a new instance based on state transition.

Trait Implementations

impl Binary for ActionEvents

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl BitAnd for ActionEvents

fn bitand(self, other: ActionEvents) -> ActionEvents

The bitwise and (&) of the bits in two flags values.

type Output = ActionEvents

The resulting type after applying the & operator.

impl BitAndAssign for ActionEvents

fn bitand_assign(&mut self, other: ActionEvents)

The bitwise and (&) of the bits in two flags values.

impl BitOr for ActionEvents

fn bitor(self, other: ActionEvents) -> ActionEvents

The bitwise or (|) of the bits in two flags values.

type Output = ActionEvents

The resulting type after applying the | operator.

impl BitOrAssign for ActionEvents

fn bitor_assign(&mut self, other: ActionEvents)

The bitwise or (|) of the bits in two flags values.

impl BitXor for ActionEvents

fn bitxor(self, other: ActionEvents) -> ActionEvents

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = ActionEvents

The resulting type after applying the ^ operator.

impl BitXorAssign for ActionEvents

fn bitxor_assign(&mut self, other: ActionEvents)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for ActionEvents

fn clone(&self) -> ActionEvents

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for ActionEvents

where ActionEvents: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = ::bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<ActionEvents>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Copy for ActionEvents

impl Debug for ActionEvents

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ActionEvents

fn default() -> ActionEvents

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ActionEvents

fn deserialize<__D>( __deserializer: __D, ) -> Result<ActionEvents, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ActionEvents

impl Extend<ActionEvents> for ActionEvents

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = ActionEvents>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for ActionEvents

const FLAGS: &'static [Flag<ActionEvents>]

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> ActionEvents

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<ActionEvents> for ActionEvents

fn from_iter<T>(iterator: T) -> ActionEvents

where T: IntoIterator<Item = ActionEvents>,

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for ActionEvents

type Item = ActionEvents

The type of the elements being iterated over.

type IntoIter = Iter<ActionEvents>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <ActionEvents as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for ActionEvents

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Not for ActionEvents

fn not(self) -> ActionEvents

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = ActionEvents

The resulting type after applying the ! operator.

impl Octal for ActionEvents

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for ActionEvents

fn eq(&self, other: &ActionEvents) -> 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 Serialize for ActionEvents

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ActionEvents

impl Sub for ActionEvents

fn sub(self, other: ActionEvents) -> ActionEvents

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = ActionEvents

The resulting type after applying the - operator.

impl SubAssign for ActionEvents

fn sub_assign(&mut self, other: ActionEvents)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for ActionEvents

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.