Struct SummarizedActionState

pub struct SummarizedActionState<A: Actionlike> { /* private fields */ }

Stores the state of all actions in the current frame.

Inside of the hashmap, Entity::PLACEHOLDER represents the global / resource state of the action.

Implementations

impl<A: Actionlike> SummarizedActionState<A>

pub fn all_entities(&self) -> HashSet<Entity>

Returns a list of all entities that are contained within this data structure.

This includes the global / resource state, using Entity::PLACEHOLDER.

pub fn summarize( global_action_state: Option<Res<'_, ActionState<A>>>, action_state_query: Query<'_, '_, (Entity, &ActionState<A>)>, ) -> Self

Captures the raw values for each action in the current frame, for all entities with ActionState<A>.

pub fn summarize_filtered<F: QueryFilter>( global_action_state: Option<Res<'_, ActionState<A>>>, action_state_query: Query<'_, '_, (Entity, &ActionState<A>), F>, ) -> Self

Captures the raw values for each action in the current frame, for entities with ActionState<A> matching the query filter.

pub fn button_diff( action: A, previous_button: Option<ButtonValue>, current_button: Option<ButtonValue>, ) -> Option<ActionDiff<A>>

Generates an ActionDiff for button data, if the button has changed state.

Previous values will be treated as default if they were not present.

pub fn axis_diff( action: A, previous_axis: Option<f32>, current_axis: Option<f32>, ) -> Option<ActionDiff<A>>

Generates an ActionDiff for axis data, if the axis has changed state.

Previous values will be treated as default if they were not present.

pub fn dual_axis_diff( action: A, previous_dual_axis: Option<Vec2>, current_dual_axis: Option<Vec2>, ) -> Option<ActionDiff<A>>

Generates an ActionDiff for dual axis data, if the dual axis has changed state.

pub fn triple_axis_diff( action: A, previous_triple_axis: Option<Vec3>, current_triple_axis: Option<Vec3>, ) -> Option<ActionDiff<A>>

Generates an ActionDiff for triple axis data, if the triple axis has changed state.

pub fn entity_diffs( &self, entity: &Entity, previous: &Self, ) -> Vec<ActionDiff<A>>

Generates all ActionDiffs for a single entity.

pub fn send_diffs( &self, previous: &Self, writer: &mut EventWriter<'_, ActionDiffEvent<A>>, )

Compares the current frame to the previous frame, generates ActionDiffs and then sends them as batched ActionDiffEvents.

Trait Implementations

impl<A: Clone + Actionlike> Clone for SummarizedActionState<A>

fn clone(&self) -> SummarizedActionState<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug + Actionlike> Debug for SummarizedActionState<A>

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

Formats the value using the given formatter.

impl<A: Actionlike> Default for SummarizedActionState<A>

fn default() -> Self

Returns the “default value” for a type.

impl<A: PartialEq + Actionlike> PartialEq for SummarizedActionState<A>

fn eq(&self, other: &SummarizedActionState<A>) -> 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<A: Actionlike> StructuralPartialEq for SummarizedActionState<A>