Skip to main content

Events

Every scene event and the argument objects event callbacks receive, with their topic.

115 in Lens API 387. Topic says where the sidebar lists each one.

NameTopicDescription
AnimationPlayerOnEventArgsAnimationArgs used for AnimationPlayer's event, which is triggered every time the animation playback passes the given time in the event.
BatteryStateArgsUtilities › Device & RuntimeStores the battery level and charging state of the device.
BrowsLoweredEventAR & Tracking › FaceTriggered when eyebrows are lowered on the tracked face.
BrowsRaisedEventAR & Tracking › FaceTriggered when eyebrows are raised on the tracked face.
BrowsReturnedToNormalEventAR & Tracking › FaceTriggered when eyebrows are returned to normal on the tracked face.
CameraBackEventAR & Tracking › CameraTriggered when the device's back facing camera becomes active.
CameraFrontEventAR & Tracking › CameraTriggered when the device's front facing camera becomes active.
CollisionEnterEventArgsPhysics › Collisions & OverlapsArgs used for ColliderComponent.onCollisionEnter, which is triggered when a collision begins.
CollisionExitEventArgsPhysics › Collisions & OverlapsArgs used for ColliderComponent.onCollisionExit, which is triggered when a collision ends.
CollisionStayEventArgsPhysics › Collisions & OverlapsArgs used for ColliderComponent.onCollisionStay, which is triggered every frame while a collision continues.
ConnectedLensEnteredEventConnected Lenses (Multiplayer)Event fired when the "Launch connected lens" button was pressed.
DeepLinkUriReceivedArgsLifecycle EventsArguments used with the DeepLinkModule#onUriReceived event.
DelayedCallbackEventLifecycle EventsAn event that gets triggered after a delay.
DoubleTapEventInteractionTriggered when a double tap event has occurred.
DoubleTapEventArgsInteractionBase class for objects representing Script data.
FaceFoundEventAR & Tracking › FaceTriggered when a new face is detected and starts being tracked.
FaceLostEventAR & Tracking › FaceTriggered when a face can no longer be tracked.
FaceTrackingEventAR & Tracking › FaceThis is the base class for all face tracking events.
FocusEndEventArgsInteractionArguments used with the InteractionComponent.onFocusEnd event.
FocusStartEventArgsInteractionArguments used with the InteractionComponent.onFocusStart event.
GesturesDataArgsInteraction
GrabBeginArgsInteractionThe arguments of the GrabBegin event on GestureModule.
GrabEndArgsInteractionThe arguments of the GrabEnd event on GestureModule.
HoverEndEventInteractionTriggered when hovering state has ended on an InteractionComponent.
HoverEndEventArgsInteractionThe arguments passed in by HoverEndEvent.
HoverEventInteractionTriggered when a mouse hover event occurs.
HoverEventArgsInteractionBase class for objects representing Script data.
HoverStartEventInteractionBase class for all object-based Event types in Lens Studio (ManipulateStartEvent, TapEvent, etc.).
HoverStartEventArgsInteractionThe arguments passed in by HoverStartEvent.
InternetStatusChangedArgsUtilities › Device & RuntimeArguments used with the onInternetStatusChanged event.
IsPhoneInHandBeginArgsInteractionThe arguments of getIsPhoneInHandBeginEvent on GestureModule.
IsPhoneInHandEndArgsInteractionThe arguments of getIsPhoneInHandEndEvent on GestureModule.
KeyPressEventInteractionThis event is triggered when the user presses a key.
KeyReleaseEventInteractionThis event is triggered when the user releases a key.
KissFinishedEventAR & Tracking › FaceTriggered when the tracked face ends a kiss.
KissStartedEventAR & Tracking › FaceTriggered when the tracked face starts a kiss.
LateUpdateEventLifecycle EventsEvent that runs during each frame, only if a Component and its SceneObject is enabled.
LongPressEndEventArgsInteractionArguments used with the InteractionComponent#onLongPressEnd event.
LongPressStartEventArgsInteractionArguments used with the InteractionComponent#onLonPressStart event.
ManipulateEndEventInteractionThis event is triggered when manipulation on the object ends.
ManipulateEndEventArgsInteractionArguments used with the ManipulateComponent.onManipulateEnd event.
ManipulateStartEventInteractionThis event is triggered when manipulation on the object begins.
ManipulateStartEventArgsInteractionArguments used with the ManipulateComponent.onManipulateStart event.
MessageEventLifecycle EventsEvent fired when a message is received from the host (Lens Studio or an AI agent).
MouthClosedEventAR & Tracking › FaceTriggered when the tracked face's mouth closes.
MouthOpenedEventAR & Tracking › FaceTriggered when the tracked face's mouth opens.
OnAwakeEventLifecycle EventsEvent that runs immediately when a Component is constructed or deserialized.
OnDestroyEventLifecycle EventsEvent that runs when a Component will be destroyed.
OnDidEnterForegroundEventLifecycle EventsTriggered when the Lens has entered the Foreground phase.
OnDidEnterSuspendedEventLifecycle EventsTriggered when the Lens has entered the Suspended phase.
OnDisableEventLifecycle EventsEvent that runs when a Component becomes disabled, either directly via its own Component.enabled property or because its SceneObject becomes disabled.
OnEnableEventLifecycle EventsEvent that runs when a Component becomes enabled, either directly via its own Component.enabled property or because its SceneObject becomes enabled.
OnFullScreenEnterEventLifecycle EventsTriggered immediately when the Lens enters full-screen mode.
OnFullScreenExitEventLifecycle EventsTriggered when the Lens returns to the standard UI with carousel and other Snapchat UI elements.
OnPauseEventLifecycle EventsTriggered when users tap the menu button in Palm UI.
OnResumeEventLifecycle EventsTriggered when users tap the menu button in Palm UI during pause state.
OnStartEventLifecycle EventsRuns on the first frame a Component is enabled, at a later point than OnAwakeEvent but guaranteed within the first frame before rendering.
OnTimeStartEventLifecycle EventsThe base class for scenewide events.
OnWillEnterForegroundEventLifecycle EventsTriggered when the Lens is about to enter the Foreground phase.
OnWillEnterSuspendedEventLifecycle EventsTriggered when the Lens is about to enter the Suspended phase.
OverlapEnterEventArgsPhysics › Collisions & OverlapsArgs used for ColliderComponent.onOverlapEnter, which is triggered when the collider begins overlapping another object.
OverlapExitEventArgsPhysics › Collisions & OverlapsArgs used for ColliderComponent.onOverlapExit, which is triggered when the collider stops overlapping another object.
OverlapStayEventArgsPhysics › Collisions & OverlapsArgs used for ColliderComponent.onOverlapStay, which is triggered every frame while the collider continues overlapping another object.
PalmTapDownArgsInteractionThe arguments of the PalmTapDown event on GestureModule
PalmTapUpArgsInteractionThe arguments of the PalmTapUp event on GestureModule
PanEndEventArgsInteractionArguments used with the InteractionComponent#onPanEnd event.
PanGestureEndEventInteractionTriggered when a pan gesture ends.
PanGestureMoveEventInteractionTriggered while the user is panning.
PanGestureStartEventInteractionTriggered when a pan gesture starts.
PanMoveEventArgsInteractionArguments used with the InteractionComponent#onPanMove event.
PanStartEventArgsInteractionArguments used with the InteractionComponent#onPanStart event.
PinchDownArgsInteractionThe arguments of the PinchDown event on GestureModule
PinchEndEventArgsInteractionArguments used with the InteractionComponent#onPinchEnd event.
PinchGestureEndEventInteractionTriggered when a pinch gesture ends.
PinchGestureMoveEventInteractionTriggered while the user is pinching.
PinchGestureStartEventInteractionTriggered when a pinch gesture starts.
PinchMoveEventArgsInteractionArguments used with the InteractionComponent#onPinchMove event.
PinchStartEventArgsInteractionArguments used with the InteractionComponent#onPinchStart event.
PinchStrengthArgsInteractionThe arguments of the PinchStrength event on GestureModule
PinchUpArgsInteractionThe arguments of the PinchUp event on GestureModule
SceneEventLifecycle EventsThe base class for scenewide events.
SceneObjectEventLifecycle EventsBase class for all object-based Event types in Lens Studio (ManipulateStartEvent, TapEvent, etc.).
ScrollEndEventArgsInteractionArguments used with the InteractionComponent#onScrollEnd event.
ScrollEventArgsInteractionArguments used with the InteractionComponent#onScroll event.
ScrollStartEventArgsInteractionArguments used with the InteractionComponent#onScrollStart event.
SelectEndEventArgsInteractionArguments used with the InteractionComponent.onSelectEnd event.
SelectStartEventArgsInteractionArguments used with the InteractionComponent.onSelectStart event.
SmileFinishedEventAR & Tracking › FaceTriggered when a smile ends on the tracked face.
SmileStartedEventAR & Tracking › FaceTriggered when a smile begins on the tracked face.
SnapImageCaptureEventLifecycle EventsCalled when the user taps on the capture button to record an image.
SnapRecordStartEventLifecycle EventsGets called when the user starts long pressing the capture button to record a Snap.
SnapRecordStopEventLifecycle EventsGets called when the user stops long pressing the Snap button to end recording of a Snap.
SpecsInteractionModule.OverlapEnterEventArgsInteraction › SpecsInteractionModuleArgs for OverlapProbe#onOverlapEnter, delivered once per frame: enteredOverlaps, every membership that entered the probe's volume this frame.
SpecsInteractionModule.OverlapExitEventArgsInteraction › SpecsInteractionModuleArgs for OverlapProbe#onOverlapExit, delivered once per frame: exitedOverlaps, every membership that left the probe's volume this frame (or whose collider wa…
SurfaceTouchDataArgsAR & Tracking › World
TapEventInteractionThis event is triggered when the user taps on the screen.
TapEventArgsInteractionArguments used with the InteractionComponent.onTap event.
TargetingDataArgsInteraction
TouchEndEventInteractionTriggered when a touch event ends.
TouchEndEventArgsInteractionArguments used with the InteractionComponent.onTouchEnd event.
TouchMoveEventInteractionTriggered when a touch position on the screen is moved.
TouchMoveEventArgsInteractionArguments used with the InteractionComponent.onTouchMove event.
TouchStartEventInteractionTriggered when a touch event starts.
TouchStartEventArgsInteractionArguments used with the InteractionComponent.onTouchStart event.
TriggerPrimaryEventInteractionGets called when the user triggers the primary input on their device.
TriggerPrimaryEventArgsInteractionArguments used with the InteractionComponent.onTriggerPrimary event.
TurnOffEventLifecycle EventsTriggered when the lens turns off.
UpdateEventLifecycle EventsEvent that runs during each frame, only if a Component and its SceneObject is enabled.
WorldTrackingMeshesAddedEventAR & Tracking › WorldTriggered when new world tracking meshes are detected.
WorldTrackingMeshesRemovedEventAR & Tracking › WorldTriggered when some world tracking meshes are no longer detected.
WorldTrackingMeshesUpdatedEventAR & Tracking › WorldTriggered when world tracking meshes are updated.
WorldTrackingPlanesAddedEventAR & Tracking › WorldTriggered when plane(s) are newly detected.
WorldTrackingPlanesRemovedEventAR & Tracking › WorldTriggered when plane(s) are no longer detected.
WorldTrackingPlanesUpdatedEventAR & Tracking › WorldTriggered when currently detected plane(s) are updated.
WorldTrackingResetEventAR & Tracking › WorldIf a DeviceTracking component is present in the scene, this event is triggered when the tracking is restarted (typically when the Lens starts, or if the user…