Struct CentralInputStore

pub struct CentralInputStore { /* private fields */ }

An overarching store for all user inputs.

This resource allows values to be updated and fetched in a single location, and ensures that their values are only recomputed once per frame.

To add a new kind of input, call CentralInputStore::register_input_kind during App setup.

Implementations

impl CentralInputStore

pub fn register_input_kind<I: UpdatableInput>( &mut self, kind: InputControlKind, app: &mut App, )

Registers a new source of raw input data of a matching kind.

This will allow the input to be updated based on the state of the world, by adding the UpdatableInput::compute system to InputManagerSystem::Unify during PreUpdate.

To improve clarity and data consistency, only one kind of input should be registered for each new data stream: compute the values of all related inputs from the data stored the CentralInputStore.

This method has no effect if the input kind has already been registered.

pub fn register_standard_input_kinds(&mut self, app: &mut App)

Registers the standard input types defined by bevy and leafwing_input_manager.

The set of input kinds registered by this method is controlled by the features enabled: turn off default features to avoid registering input kinds that are not needed.

pub fn clear(&mut self)

Clears all existing values.

This should be called once at the start of each frame, before polling for new input.

pub fn update_buttonlike<B: Buttonlike>(&mut self, buttonlike: B, pressed: bool)

Updates the value of a Buttonlike input.

pub fn update_axislike<A: Axislike>(&mut self, axislike: A, value: f32)

Updates the value of an Axislike input.

pub fn update_dualaxislike<D: DualAxislike>( &mut self, dualaxislike: D, value: Vec2, )

Updates the value of a DualAxislike input.

pub fn update_tripleaxislike<T: TripleAxislike>( &mut self, tripleaxislike: T, value: Vec3, )

Updates the value of a TripleAxislike input.

pub fn pressed<B: Buttonlike + Hash + Eq + Clone>(&self, buttonlike: &B) -> bool

Fetches the value of a Buttonlike input.

pub fn value<A: Axislike + Hash + Eq + Clone>(&self, axislike: &A) -> f32

Fetches the value of an Axislike input.

pub fn pair<D: DualAxislike + Hash + Eq + Clone>( &self, dualaxislike: &D, ) -> Vec2

Fetches the value of a DualAxislike input.

pub fn triple<T: TripleAxislike + Hash + Eq + Clone>( &self, tripleaxislike: &T, ) -> Vec3

Fetches the value of a TripleAxislike input.

Trait Implementations

impl Debug for CentralInputStore

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

Formats the value using the given formatter.

impl Default for CentralInputStore

fn default() -> CentralInputStore

Returns the “default value” for a type.

impl FromReflect for CentralInputStore

where Self: Any + Send + Sync, HashMap<TypeId, UpdatedValues>: FromReflect + TypePath + RegisterForReflection, HashSet<TypeId>: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect>, ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for CentralInputStore

where Self: Any + Send + Sync, HashMap<TypeId, UpdatedValues>: FromReflect + TypePath + RegisterForReflection, HashSet<TypeId>: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Reflect for CentralInputStore

where Self: Any + Send + Sync, HashMap<TypeId, UpdatedValues>: FromReflect + TypePath + RegisterForReflection, HashSet<TypeId>: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for CentralInputStore

where Self: Any + Send + Sync, HashMap<TypeId, UpdatedValues>: FromReflect + TypePath + RegisterForReflection, HashSet<TypeId>: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for CentralInputStore

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for CentralInputStore

where Self: Any + Send + Sync, HashMap<TypeId, UpdatedValues>: FromReflect + TypePath + RegisterForReflection, HashSet<TypeId>: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Resource for CentralInputStore

where Self: Send + Sync + 'static,