Lens Scripting API
    Preparing search index...

    Class ButtonInputEventExperimental

    Fired when a button is pressed or released on a connected controller.

    Lens Scripting Version 373

    //@input Asset.GameControllerModule gameControllerModule
    var provider = script.gameControllerModule.createController();
    provider.onButtonEvent.add(function(event) {
        print("Button " + event.button + " (" + event.eventType + ") on controller " + event.controllerId);
    });

    Hierarchy (View Summary)

    Index

    Properties

    button controllerId eventType timestamp

    Methods

    getTypeName getTypeName isOfType isSame

    Properties

    button: Button

    Which button changed state.

    Lens Scripting Version 373

    controllerId: number

    Unique identifier of the controller that produced the event.

    Lens Scripting Version 373

    eventType: ButtonEventType

    Whether the button was pressed or released.

    Lens Scripting Version 373

    timestamp: number

    Timestamp of the event in milliseconds (steady system clock).

    Lens Scripting Version 373

    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

    Properties
    Methods