Skip to main content

KissFinishedEvent

Class

Triggered when the tracked face ends a kiss.

  • 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

var event = script.createEvent("KissFinishedEvent");
event.faceIndex = 0;
event.bind(function (eventData)
{
print("Kiss finished on face 0");
});

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

FaceTrackingEvent.enabled


faceIndex

faceIndex: number

The index of the face this event is tracking. Change this value to control which face the event tracks.

Default Value

0

Inherited from

FaceTrackingEvent.faceIndex


trackingScope

trackingScope: FaceTrackingScope | TextureTrackingScope | PersonTrackingScope

The tracking context this effect is being applied to.

Since

Lens Scripting Version 309

Default Value

null

Inherited from

FaceTrackingEvent.trackingScope

Methods

bind()

bind(evCallback): void

Binds a callback function to this event.

Parameters

ParameterType
evCallback(arg1) => void

Returns

void

Inherited from

FaceTrackingEvent.bind


getTypeName()

static getTypeName(): TypeName<KissFinishedEvent>

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

Overrides

FaceTrackingEvent.getTypeName


getTypeName()

getTypeName(): string

Returns the typename of the SceneEvent.

Returns

string

Inherited from

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

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

FaceTrackingEvent.isSame