GameControllerModule.ControllerInfo
ClassMetadata describing a connected game controller.
- Snapchat: not supported
- SPECS: fully supported
- Camera Kit Web: not supported
- Camera Kit Mobile: not supported
- 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
Since Lens Scripting v373Experimental
Metadata describing a connected game controller.
Index
Properties
Methods
Example
//@input Asset.GameControllerModule gameControllerModule
var provider = script.gameControllerModule.createController();
provider.getConnectedControllers().forEach(function(controller) {
print(controller.name + " (type: " + controller.type + ")");
});
Extends
Properties
capabilities
readonlycapabilities:number
ExperimentalSPECS
Bitmask of optional capabilities. Test with hasCapability() or ControllerCapability values.
Since
Lens Scripting Version 373
id
readonlyid:number
ExperimentalSPECS
Unique identifier for this controller within the current session.
Since
Lens Scripting Version 373
name
readonlyname:string
ExperimentalSPECS
Human-readable name of the controller.
Since
Lens Scripting Version 373
type
readonlytype:ControllerType
ExperimentalSPECS
The controller family. Use to display platform-appropriate button labels.
Since
Lens Scripting Version 373
Methods
getTypeName()
staticgetTypeName():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
getTypeName()
getTypeName():
string
Experimental
Returns the name of this object's type.
Returns
string
Inherited from
hasCapability()
hasCapability(
capability):boolean
ExperimentalSPECS
Returns whether this controller supports a specific capability (e.g. motion sensors, touchpad, analog triggers).
Parameters
| Parameter | Type |
|---|---|
capability | ControllerCapability |
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
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean