Skip to main content

TapEvent

Class

This event is triggered when the user taps on the screen.

  • 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

function onTapped(eventData)
{
print("Tap Position: (" + eventData.getTapPosition().x + ", " + eventData.getTapPosition().y + ")");
}

var event = script.createEvent("TapEvent");
event.bind(onTapped);

Extends

Properties

enabled

enabled: boolean

If true, the event is able to trigger. If false, the event will not trigger.

Default Value

true

Inherited from

SceneObjectEvent.enabled

Methods

bind()

bind(evCallback): void

Binds a callback function to this event.

Parameters

ParameterType
evCallback(arg1) => void

Returns

void

Inherited from

SceneObjectEvent.bind


getSceneObject()

getSceneObject(): SceneObject

Returns the SceneObject this Event is associated with.

Returns

SceneObject

Inherited from

SceneObjectEvent.getSceneObject


getTapPosition()

getTapPosition(): vec2

Returns the normalized 2D screen position of the user's tap. The normalized coordinates range from ([0-1], [0-1]), (0,0) being top-left and (1,1) being bottom-right.

Returns

vec2

Since

Lens Scripting Version 330


getTypeName()

static getTypeName(): TypeName<TapEvent>

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

Overrides

SceneObjectEvent.getTypeName


getTypeName()

getTypeName(): string

Returns the typename of the SceneEvent.

Returns

string

Inherited from

SceneObjectEvent.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

SceneObjectEvent.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

SceneObjectEvent.isSame