Trait Buttonlike

pub trait Buttonlike:
    UserInput
    + DynClone
    + DynEq
    + DynHash
    + Reflect
    + Serialize {
    // Required method
    fn pressed(&self, input_store: &CentralInputStore, gamepad: Gamepad) -> bool;

    // Provided methods
    fn released(
        &self,
        input_store: &CentralInputStore,
        gamepad: Gamepad,
    ) -> bool { ... }
    fn press(&self, world: &mut World) { ... }
    fn press_as_gamepad(&self, world: &mut World, _gamepad: Option<Gamepad>) { ... }
    fn release(&self, world: &mut World) { ... }
    fn release_as_gamepad(&self, world: &mut World, _gamepad: Option<Gamepad>) { ... }
}

A trait used for buttonlike user inputs, which can be pressed or released.

Required Methods

fn pressed(&self, input_store: &CentralInputStore, gamepad: Gamepad) -> bool

Checks if the input is currently active.

Provided Methods

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

Checks if the input is currently inactive.

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

Simulates a press of the buttonlike input by sending the appropriate event.

This method defaults to calling Buttonlike::press_as_gamepad if not overridden, as is the case for gamepad-reliant inputs.

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

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

This method defaults to calling Buttonlike::press if not overridden, as is the case for things like mouse buttons and keyboard keys.

Use find_gamepad inside of this method to search for a gamepad to press the button on if the provided gamepad is None.

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

Simulates a release of the buttonlike input by sending the appropriate event.

This method defaults to calling Buttonlike::release_as_gamepad if not overridden, as is the case for gamepad-reliant inputs.

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

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

This method defaults to calling Buttonlike::release if not overridden, as is the case for things like mouse buttons and keyboard keys.

Use find_gamepad inside of this method to search for a gamepad to press the button on if the provided gamepad is None.

Trait Implementations

impl<'de> Deserialize<'de> for Box<dyn Buttonlike>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromReflect for Box<dyn Buttonlike>

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 Box<dyn Buttonlike>

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> Hash for dyn Buttonlike + 'hash

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

Feeds this value into the given Hasher.

impl<'hash> Hash for dyn Buttonlike + Send + 'hash

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

Feeds this value into the given Hasher.

impl<'hash> Hash for dyn Buttonlike + Send + Sync + 'hash

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

Feeds this value into the given Hasher.

impl<'hash> Hash for dyn Buttonlike + Sync + 'hash

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

Feeds this value into the given Hasher.

impl<'eq> PartialEq<&Box<dyn Buttonlike + 'eq>> for Box<dyn Buttonlike + 'eq>

fn eq(&self, other: &&Self) -> 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<'eq> PartialEq<&Box<dyn Buttonlike + Send + 'eq>> for Box<dyn Buttonlike + Send + 'eq>

fn eq(&self, other: &&Self) -> 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<'eq> PartialEq<&Box<dyn Buttonlike + Send + Sync + 'eq>> for Box<dyn Buttonlike + Send + Sync + 'eq>

fn eq(&self, other: &&Self) -> 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<'eq> PartialEq<&Box<dyn Buttonlike + Sync + 'eq>> for Box<dyn Buttonlike + Sync + 'eq>

fn eq(&self, other: &&Self) -> 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<'eq> PartialEq for dyn Buttonlike + 'eq

fn eq(&self, other: &Self) -> 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<'eq> PartialEq for dyn Buttonlike + Send + 'eq

fn eq(&self, other: &Self) -> 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<'eq> PartialEq for dyn Buttonlike + Send + Sync + 'eq

fn eq(&self, other: &Self) -> 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<'eq> PartialEq for dyn Buttonlike + Sync + 'eq

fn eq(&self, other: &Self) -> 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 Reflect for Box<dyn Buttonlike>

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 try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

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

Applies a reflected value to this 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.

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 clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

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

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

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

Returns a “partial equality” comparison result.

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

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<'de> RegisterTypeTag<'de, dyn Buttonlike> for ButtonlikeChord

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

Registers the specified type tag into the InfallibleMapRegistry.

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

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

Registers the specified type tag into the InfallibleMapRegistry.

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

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

Registers the specified type tag into the InfallibleMapRegistry.

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

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

Registers the specified type tag into the InfallibleMapRegistry.

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

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

Registers the specified type tag into the InfallibleMapRegistry.

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<'de> RegisterTypeTag<'de, dyn Buttonlike> for MouseButton

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

Registers the specified type tag into the InfallibleMapRegistry.

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

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

Registers the specified type tag into the InfallibleMapRegistry.

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

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

Registers the specified type tag into the InfallibleMapRegistry.

impl<'a> Serialize for dyn Buttonlike + 'a

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 Box<dyn Buttonlike>

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 Box<dyn Buttonlike>

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<'eq> Eq for dyn Buttonlike + 'eq

impl<'eq> Eq for dyn Buttonlike + Send + 'eq

impl<'eq> Eq for dyn Buttonlike + Send + Sync + 'eq

impl<'eq> Eq for dyn Buttonlike + Sync + 'eq

Implementations on Foreign Types

impl Buttonlike for GamepadButtonType

fn pressed(&self, input_store: &CentralInputStore, gamepad: Gamepad) -> bool

Checks if the specified button is currently pressed down.

fn press_as_gamepad(&self, world: &mut World, gamepad: Option<Gamepad>)

Sends a GamepadEvent::Button event with a magnitude of 1.0 in the direction defined by self on the provided Gamepad.

fn release_as_gamepad(&self, world: &mut World, gamepad: Option<Gamepad>)

Sends a GamepadEvent::Button event with a magnitude of 0.0 in the direction defined by self on the provided Gamepad.

impl Buttonlike for KeyCode

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

Checks if the specified key is currently pressed down.

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

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

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.

Note

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

impl Buttonlike for MouseButton

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

Checks if the specified button is currently pressed down.

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

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

Note

The window field will be filled with a placeholder value.

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

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

Note

The window field will be filled with a placeholder value.

impl Buttonlike for GamepadButton

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

WARNING: The supplied gamepad is ignored, as the button is already specific to a gamepad.

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

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

Implementors

impl Buttonlike for ModifierKey

impl Buttonlike for ButtonlikeChord

impl Buttonlike for GamepadControlDirection

impl Buttonlike for MouseMoveDirection

impl Buttonlike for MouseScrollDirection