Skip to main content

GameControllerModule.ControllerInfo

Class

Metadata describing a connected game controller.

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: not supported
  • Camera Kit Mobile: not supported
1 platform note
  • SnapchatNot supported — Available on SPECS only
  • SPECSFully supported
    • Experimental API; it may change or be removed.
  • Camera Kit WebNot supported — Available on SPECS only
  • Camera Kit MobileNot supported — Available on SPECS only

Platform details

  • Snapchat — Not supported — Available on SPECS only.

  • SPECS — Fully supported. Experimental API; it may change or be removed

  • Camera Kit Web — Not supported — Available on SPECS only.

  • Camera Kit Mobile — Not supported — Available on SPECS only.

Since Lens Scripting v373Experimental

Metadata describing a connected game controller.

Index

Example

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

Extends

Properties

capabilities

readonly capabilities: number

ExperimentalSPECS

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

Since

Lens Scripting Version 373


id

readonly id: number

ExperimentalSPECS

Unique identifier for this controller within the current session.

Since

Lens Scripting Version 373


name

readonly name: string

ExperimentalSPECS

Human-readable name of the controller.

Since

Lens Scripting Version 373


type

readonly type: ControllerType

ExperimentalSPECS

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

Since

Lens Scripting Version 373

Methods

getTypeName()

static getTypeName(): TypeName<ControllerInfo>

ExperimentalSPECS

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

TypeName<ControllerInfo>

Since

Lens Scripting Version 373

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Experimental

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


hasCapability()

hasCapability(capability): boolean

ExperimentalSPECS

Returns whether this controller supports a specific capability (e.g. motion sensors, touchpad, analog triggers).

Parameters

ParameterType
capabilityControllerCapability

Returns

boolean

Since

Lens Scripting Version 373


isOfType()

isOfType(type): boolean

Experimental

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

Experimental

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

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame