Lens Scripting API
    Preparing search index...

    Class RumbleOptionsExperimental

    Options for a haptic feedback (rumble) request. Uses a dual-motor model: a heavy low-frequency motor and a light high-frequency motor.

    Lens Scripting Version 373

    //@input Asset.GameControllerModule gameControllerModule
    var provider = script.gameControllerModule.createController();
    provider.onButtonEvent.add(function(event) {
        var options = new GameControllerModule.RumbleOptions();
        options.controllerId = event.controllerId;
        options.lowFrequencyIntensity = 0.5;
        options.highFrequencyIntensity = 0.3;
        options.durationSec = 0.2;
        provider.rumble(options);
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    controllerId durationSec highFrequencyIntensity lowFrequencyIntensity

    Methods

    getTypeName getTypeName isOfType isSame

    Constructors

    Properties

    controllerId: number

    Unique identifier of the target controller.

    Lens Scripting Version 373

    0
    @experimental
    durationSec: number

    Duration of the rumble effect in seconds.

    Lens Scripting Version 373

    0.5
    @experimental
    highFrequencyIntensity: number

    Strength of the light/fast rumble motor, from 0.0 (off) to 1.0 (maximum).

    Lens Scripting Version 373

    0
    @experimental
    lowFrequencyIntensity: number

    Strength of the heavy/slow rumble motor, from 0.0 (off) to 1.0 (maximum).

    Lens Scripting Version 373

    0
    @experimental

    Methods

    • Experimental

      Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      Returns string

      Lens Scripting Version 373

    • Experimental

      Returns the name of this object's type.

      Returns string

    • Experimental

      Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Experimental

      Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods