Struct GamepadRumbleIntensity 

pub struct GamepadRumbleIntensity {
    pub strong_motor: f32,
    pub weak_motor: f32,
}

Available on crate feature gamepad only.

The intensity at which a gamepad’s force-feedback motors may rumble.

Fields

strong_motor: f32

The rumble intensity of the strong gamepad motor.

Ranges from 0.0 to 1.0.

By convention, this is usually a low-frequency motor on the left-hand side of the gamepad, though it may vary across platforms and hardware.

weak_motor: f32

The rumble intensity of the weak gamepad motor.

Ranges from 0.0 to 1.0.

By convention, this is usually a high-frequency motor on the right-hand side of the gamepad, though it may vary across platforms and hardware.

Implementations

impl GamepadRumbleIntensity

pub const MAX: GamepadRumbleIntensity

Rumble both gamepad motors at maximum intensity.

pub const WEAK_MAX: GamepadRumbleIntensity

Rumble the weak motor at maximum intensity.

pub const STRONG_MAX: GamepadRumbleIntensity

Rumble the strong motor at maximum intensity.

pub const fn weak_motor(intensity: f32) -> GamepadRumbleIntensity

Creates a new rumble intensity with weak motor intensity set to the given value.

Clamped within the 0.0 to 1.0 range.

Examples found in repository

examples/input/gamepad_rumble.rs (line 47)

fn gamepad_system(
    gamepads: Query<(Entity, &Gamepad)>,
    mut rumble_requests: MessageWriter<GamepadRumbleRequest>,
) {
    for (entity, gamepad) in &gamepads {
        if gamepad.just_pressed(GamepadButton::North) {
            info!(
                "North face button: strong (low-frequency) with low intensity for rumble for 5 seconds. Press multiple times to increase intensity."
            );
            rumble_requests.write(GamepadRumbleRequest::Add {
                gamepad: entity,
                intensity: GamepadRumbleIntensity::strong_motor(0.1),
                duration: Duration::from_secs(5),
            });
        }

        if gamepad.just_pressed(GamepadButton::East) {
            info!("East face button: maximum rumble on both motors for 5 seconds");
            rumble_requests.write(GamepadRumbleRequest::Add {
                gamepad: entity,
                duration: Duration::from_secs(5),
                intensity: GamepadRumbleIntensity::MAX,
            });
        }

        if gamepad.just_pressed(GamepadButton::South) {
            info!("South face button: low-intensity rumble on the weak motor for 0.5 seconds");
            rumble_requests.write(GamepadRumbleRequest::Add {
                gamepad: entity,
                duration: Duration::from_secs_f32(0.5),
                intensity: GamepadRumbleIntensity::weak_motor(0.25),
            });
        }

        if gamepad.just_pressed(GamepadButton::West) {
            info!("West face button: custom rumble intensity for 5 second");
            rumble_requests.write(GamepadRumbleRequest::Add {
                gamepad: entity,
                intensity: GamepadRumbleIntensity {
                    // intensity low-frequency motor, usually on the left-hand side
                    strong_motor: 0.5,
                    // intensity of high-frequency motor, usually on the right-hand side
                    weak_motor: 0.25,
                },
                duration: Duration::from_secs(5),
            });
        }

        if gamepad.just_pressed(GamepadButton::Start) {
            info!("Start button: Interrupt the current rumble");
            rumble_requests.write(GamepadRumbleRequest::Stop { gamepad: entity });
        }
    }
}

pub const fn strong_motor(intensity: f32) -> GamepadRumbleIntensity

Creates a new rumble intensity with strong motor intensity set to the given value.

Clamped within the 0.0 to 1.0 range.

Examples found in repository

examples/input/gamepad_rumble.rs (line 28)

fn gamepad_system(
    gamepads: Query<(Entity, &Gamepad)>,
    mut rumble_requests: MessageWriter<GamepadRumbleRequest>,
) {
    for (entity, gamepad) in &gamepads {
        if gamepad.just_pressed(GamepadButton::North) {
            info!(
                "North face button: strong (low-frequency) with low intensity for rumble for 5 seconds. Press multiple times to increase intensity."
            );
            rumble_requests.write(GamepadRumbleRequest::Add {
                gamepad: entity,
                intensity: GamepadRumbleIntensity::strong_motor(0.1),
                duration: Duration::from_secs(5),
            });
        }

        if gamepad.just_pressed(GamepadButton::East) {
            info!("East face button: maximum rumble on both motors for 5 seconds");
            rumble_requests.write(GamepadRumbleRequest::Add {
                gamepad: entity,
                duration: Duration::from_secs(5),
                intensity: GamepadRumbleIntensity::MAX,
            });
        }

        if gamepad.just_pressed(GamepadButton::South) {
            info!("South face button: low-intensity rumble on the weak motor for 0.5 seconds");
            rumble_requests.write(GamepadRumbleRequest::Add {
                gamepad: entity,
                duration: Duration::from_secs_f32(0.5),
                intensity: GamepadRumbleIntensity::weak_motor(0.25),
            });
        }

        if gamepad.just_pressed(GamepadButton::West) {
            info!("West face button: custom rumble intensity for 5 second");
            rumble_requests.write(GamepadRumbleRequest::Add {
                gamepad: entity,
                intensity: GamepadRumbleIntensity {
                    // intensity low-frequency motor, usually on the left-hand side
                    strong_motor: 0.5,
                    // intensity of high-frequency motor, usually on the right-hand side
                    weak_motor: 0.25,
                },
                duration: Duration::from_secs(5),
            });
        }

        if gamepad.just_pressed(GamepadButton::Start) {
            info!("Start button: Interrupt the current rumble");
            rumble_requests.write(GamepadRumbleRequest::Stop { gamepad: entity });
        }
    }
}

Trait Implementations

impl Clone for GamepadRumbleIntensity

fn clone(&self) -> GamepadRumbleIntensity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for GamepadRumbleIntensity

impl Debug for GamepadRumbleIntensity

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

Formats the value using the given formatter.

impl FromArg for GamepadRumbleIntensity

type This<'from_arg> = GamepadRumbleIntensity

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<GamepadRumbleIntensity as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromReflect for GamepadRumbleIntensity

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<GamepadRumbleIntensity>

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 GetOwnership for GamepadRumbleIntensity

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for GamepadRumbleIntensity

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 IntoReturn for GamepadRumbleIntensity

fn into_return<'into_return>(self) -> Return<'into_return>

where GamepadRumbleIntensity: 'into_return,

Converts Self into a Return value.

impl PartialEq for GamepadRumbleIntensity

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

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: &(dyn PartialReflect + 'static), ) -> 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<GamepadRumbleIntensity>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<GamepadRumbleIntensity>, ) -> 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 + 'static)>

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

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

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

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

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

fn reflect_partial_cmp( &self, value: &(dyn PartialReflect + 'static), ) -> Option<Ordering>

Returns a “partial comparison” result.

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

Debug formatter for the value.

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 to_dynamic(&self) -> Box<dyn PartialReflect>

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

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

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

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

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for GamepadRumbleIntensity

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

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

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

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

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 Struct for GamepadRumbleIntensity

fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

Gets a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut( &mut self, name: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Gets a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Gets a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Gets a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

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

Gets the name of the field with index index.

fn index_of_name(&self, name: &str) -> Option<usize>

Gets the index of the field with the given name.

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 to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl StructuralPartialEq for GamepadRumbleIntensity

impl TypePath for GamepadRumbleIntensity

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 GamepadRumbleIntensity

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.