Skip to main content

TouchStartEventArgs

Class

Arguments used with the InteractionComponent.onTouchStart event.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Index

Example

//@input Component.InteractionComponent interactionComponent

// Subscribe to the onTouchStart event
var onTouchStartEvent = script.interactionComponent.onTouchStart.add(function(touchStartEventArgs){
print("Touch Start! Touched at: " + touchStartEventArgs.position + " for touchId: " + touchStartEventArgs.touchId);
});

// Unsubscribe from the onTouchStart event
script.interactionComponent.onTouchStart.remove(onTouchStartEvent);

Extends

Properties

position

readonly position: vec2

The position of the touch on the screen. [0,0] being top left, and [1,1] being bottom right.

Since

Lens Scripting Version 193


touchId

readonly touchId: number

Returns the ID of this specific touch. Useful for distinguishing between touches when multiple are occurring simultaneously.

Since

Lens Scripting Version 148

Methods

getTypeName()

static getTypeName(): TypeName<TouchStartEventArgs>

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<TouchStartEventArgs>

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

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

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