Lens Scripting API
    Preparing search index...

    Class ControllerInfoExperimental

    Metadata describing a connected game controller.

    Lens Scripting Version 373

    //@input Asset.GameControllerModule gameControllerModule
    var provider = script.gameControllerModule.createController();
    provider.getConnectedControllers().forEach(function(controller) {
        print(controller.name + " (type: " + controller.type + ")");
    });

    Hierarchy (View Summary)

    Index

    Properties

    capabilities id name type

    Methods

    getTypeName getTypeName hasCapability isOfType isSame

    Properties

    capabilities: number

    Bitmask of optional capabilities. Test with hasCapability() or ControllerCapability values.

    Lens Scripting Version 373

    id: number

    Unique identifier for this controller within the current session.

    Lens Scripting Version 373

    name: string

    Human-readable name of the controller.

    Lens Scripting Version 373

    type: ControllerType

    The controller family. Use to display platform-appropriate button labels.

    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 whether this controller supports a specific capability (e.g. motion sensors, touchpad, analog triggers).

      Parameters

      Returns boolean

      Lens Scripting Version 373

    • 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