Lens Scripting API
    Preparing search index...

    Enumeration ButtonExperimental

    Common gamepad button identifiers. Face buttons use positional names (compass directions when looking at the right-hand button diamond) so they are layout-neutral across controller families. Use ControllerInfo.type to map these to platform-appropriate labels.

    Lens Scripting Version 373

    //@input Asset.GameControllerModule gameControllerModule
    var provider = script.gameControllerModule.createController();
    provider.onButtonEvent.add(function(event) {
        if (event.button === GameControllerModule.Button.South) {
            print("South button (Xbox A / PlayStation Cross)");
        }
    });
    Index

    Enumeration Members

    DpadDown DpadLeft DpadRight DpadUp East LeftBumper LeftThumbstick LeftTrigger North RightBumper RightThumbstick RightTrigger Select South Start West

    Enumeration Members

    DpadDown: number

    D-pad down.

    Lens Scripting Version 373

    DpadLeft: number

    D-pad left.

    Lens Scripting Version 373

    DpadRight: number

    D-pad right.

    Lens Scripting Version 373

    DpadUp: number

    D-pad up.

    Lens Scripting Version 373

    East: number

    Right face button (Xbox: B, PlayStation: Circle, Switch: A).

    Lens Scripting Version 373

    LeftBumper: number

    Left shoulder button.

    Lens Scripting Version 373

    LeftThumbstick: number

    Left thumbstick click (L3).

    Lens Scripting Version 373

    LeftTrigger: number

    Left trigger (digital press; for analog value use onAnalogTriggerEvent).

    Lens Scripting Version 373

    North: number

    Top face button (Xbox: Y, PlayStation: Triangle, Switch: X).

    Lens Scripting Version 373

    RightBumper: number

    Right shoulder button.

    Lens Scripting Version 373

    RightThumbstick: number

    Right thumbstick click (R3).

    Lens Scripting Version 373

    RightTrigger: number

    Right trigger (digital press; for analog value use onAnalogTriggerEvent).

    Lens Scripting Version 373

    Select: number

    Select / Share / Minus button.

    Lens Scripting Version 373

    South: number

    Bottom face button (Xbox: A, PlayStation: Cross, Switch: B).

    Lens Scripting Version 373

    Start: number

    Start / Options / Plus button.

    Lens Scripting Version 373

    West: number

    Left face button (Xbox: X, PlayStation: Square, Switch: Y).

    Lens Scripting Version 373

    Settings

    Member Visibility

    On This Page

    Enumeration Members