Enum ModifierKey

pub enum ModifierKey {
    Alt,
    Control,
    Shift,
    Super,
}

Keyboard modifiers like Alt, Control, Shift, and Super (OS symbol key).

Each variant represents a pair of KeyCodes, the left and right version of the modifier key, allowing for handling modifiers regardless of which side is pressed.

Variants

Alt

The Alt key, representing either KeyCode::AltLeft or KeyCode::AltRight.

Control

The Control key, representing either KeyCode::ControlLeft or KeyCode::ControlRight.

Shift

The Shift key, representing either KeyCode::ShiftLeft or KeyCode::ShiftRight.

Super

The Super (OS symbol) key, representing either KeyCode::SuperLeft or KeyCode::SuperRight.

Implementations

impl ModifierKey

pub const fn keycodes(&self) -> [KeyCode; 2]

Returns a pair of KeyCodes corresponding to both modifier keys.

pub const fn left(&self) -> KeyCode

Returns the KeyCode corresponding to the left modifier key.

pub const fn right(&self) -> KeyCode

Returns the KeyCode corresponding to the right modifier key.

pub fn with(&self, other: impl Buttonlike) -> ButtonlikeChord

Create an ButtonlikeChord that includes this ModifierKey and the given input.

Trait Implementations

impl Buttonlike for ModifierKey

fn pressed(&self, input_store: &CentralInputStore, _gamepad: Entity) -> bool

Checks if the specified modifier key is currently pressed down.

fn press(&self, world: &mut World)

Sends a fake KeyboardInput event to the world with ButtonState::Pressed.

The left and right keys will be pressed simultaneously.

Note

The logical_key and window fields will be filled with placeholder values.

fn release(&self, world: &mut World)

Sends a fake KeyboardInput event to the world with ButtonState::Released.

The left and right keys will be released simultaneously.

Note

The logical_key and window fields will be filled with placeholder values.

fn set_value(&self, world: &mut World, value: f32)

If the value is greater than 0.0, press the keys; otherwise release it.

fn released(&self, input_store: &CentralInputStore, gamepad: Entity) -> bool

Checks if the input is currently inactive.

fn value(&self, input_store: &CentralInputStore, gamepad: Entity) -> f32

Gets the current value of the button as an f32.

fn press_as_gamepad(&self, world: &mut World, _gamepad: Option<Entity>)

Simulate a press of the buttonlike input, pretending to be the provided gamepad Entity.

fn release_as_gamepad(&self, world: &mut World, _gamepad: Option<Entity>)

Simulate a release of the buttonlike input, pretending to be the provided gamepad Entity.

fn set_value_as_gamepad( &self, world: &mut World, value: f32, _gamepad: Option<Entity>, )

Simulate a value change of the buttonlike input, pretending to be the provided gamepad Entity.

impl Clone for ModifierKey

fn clone(&self) -> ModifierKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModifierKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModifierKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Enum for ModifierKey

where ModifierKey: Any + Send + Sync,

fn field(&self, __name_param: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, __index_param: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut(&mut self, __name_param: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut( &mut self, __index_param: usize, ) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

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

Returns the name of the field (in the current variant) with the given index.

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

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn to_dynamic_enum(&self) -> DynamicEnum

Creates a new DynamicEnum from this enum.

fn clone_dynamic(&self) -> DynamicEnum

👎Deprecated since 0.16.0: use to_dynamic_enum instead

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

fn get_represented_enum_info(&self) -> Option<&'static EnumInfo>

Will return None if TypeInfo is not available.

impl FromReflect for ModifierKey

where ModifierKey: Any + Send + Sync,

fn from_reflect(__param0: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for ModifierKey

where ModifierKey: Any + Send + Sync,

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 Hash for ModifierKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ModifierKey

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

where ModifierKey: Any + Send + Sync,

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

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, __value_param: &dyn PartialReflect, ) -> 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 try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

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

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

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

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

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

Applies a reflected value to this value.

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

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for ModifierKey

where ModifierKey: Any + Send + Sync,

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, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

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

Casts this type to a mutable, fully-reflected value.

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

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

impl<'de> RegisterTypeTag<'de, dyn Buttonlike> for ModifierKey

fn register_typetag(registry: &mut InfallibleMapRegistry<dyn Buttonlike>)

Registers the specified type tag into the InfallibleMapRegistry.

impl Serialize for ModifierKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypePath for ModifierKey

where ModifierKey: 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 ModifierKey

where ModifierKey: Any + Send + Sync,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl UserInput for ModifierKey

fn kind(&self) -> InputControlKind

ModifierKey acts as a button.

fn decompose(&self) -> BasicInputs

Returns the two KeyCodes used by this ModifierKey.

impl Copy for ModifierKey

impl Eq for ModifierKey

impl StructuralPartialEq for ModifierKey