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.
| Name | Topic | Description |
|---|---|---|
| AnimationPlayerOnEventArgs | Animation | Args used for AnimationPlayer's event, which is triggered every time the animation playback passes the given time in the event. |
| BatteryStateArgs | Utilities › Device & Runtime | Stores the battery level and charging state of the device. |
| BrowsLoweredEvent | AR & Tracking › Face | Triggered when eyebrows are lowered on the tracked face. |
| BrowsRaisedEvent | AR & Tracking › Face | Triggered when eyebrows are raised on the tracked face. |
| BrowsReturnedToNormalEvent | AR & Tracking › Face | Triggered when eyebrows are returned to normal on the tracked face. |
| CameraBackEvent | AR & Tracking › Camera | Triggered when the device's back facing camera becomes active. |
| CameraFrontEvent | AR & Tracking › Camera | Triggered when the device's front facing camera becomes active. |
| CollisionEnterEventArgs | Physics › Collisions & Overlaps | Args used for ColliderComponent.onCollisionEnter, which is triggered when a collision begins. |
| CollisionExitEventArgs | Physics › Collisions & Overlaps | Args used for ColliderComponent.onCollisionExit, which is triggered when a collision ends. |
| CollisionStayEventArgs | Physics › Collisions & Overlaps | Args used for ColliderComponent.onCollisionStay, which is triggered every frame while a collision continues. |
| ConnectedLensEnteredEvent | Connected Lenses (Multiplayer) | Event fired when the "Launch connected lens" button was pressed. |
| DeepLinkUriReceivedArgs | Lifecycle Events | Arguments used with the DeepLinkModule#onUriReceived event. |
| DelayedCallbackEvent | Lifecycle Events | An event that gets triggered after a delay. |
| DoubleTapEvent | Interaction | Triggered when a double tap event has occurred. |
| DoubleTapEventArgs | Interaction | Base class for objects representing Script data. |
| FaceFoundEvent | AR & Tracking › Face | Triggered when a new face is detected and starts being tracked. |
| FaceLostEvent | AR & Tracking › Face | Triggered when a face can no longer be tracked. |
| FaceTrackingEvent | AR & Tracking › Face | This is the base class for all face tracking events. |
| FocusEndEventArgs | Interaction | Arguments used with the InteractionComponent.onFocusEnd event. |
| FocusStartEventArgs | Interaction | Arguments used with the InteractionComponent.onFocusStart event. |
| GesturesDataArgs | Interaction | |
| GrabBeginArgs | Interaction | The arguments of the GrabBegin event on GestureModule. |
| GrabEndArgs | Interaction | The arguments of the GrabEnd event on GestureModule. |
| HoverEndEvent | Interaction | Triggered when hovering state has ended on an InteractionComponent. |
| HoverEndEventArgs | Interaction | The arguments passed in by HoverEndEvent. |
| HoverEvent | Interaction | Triggered when a mouse hover event occurs. |
| HoverEventArgs | Interaction | Base class for objects representing Script data. |
| HoverStartEvent | Interaction | Base class for all object-based Event types in Lens Studio (ManipulateStartEvent, TapEvent, etc.). |
| HoverStartEventArgs | Interaction | The arguments passed in by HoverStartEvent. |
| InternetStatusChangedArgs | Utilities › Device & Runtime | Arguments used with the onInternetStatusChanged event. |
| IsPhoneInHandBeginArgs | Interaction | The arguments of getIsPhoneInHandBeginEvent on GestureModule. |
| IsPhoneInHandEndArgs | Interaction | The arguments of getIsPhoneInHandEndEvent on GestureModule. |
| KeyPressEvent | Interaction | This event is triggered when the user presses a key. |
| KeyReleaseEvent | Interaction | This event is triggered when the user releases a key. |
| KissFinishedEvent | AR & Tracking › Face | Triggered when the tracked face ends a kiss. |
| KissStartedEvent | AR & Tracking › Face | Triggered when the tracked face starts a kiss. |
| LateUpdateEvent | Lifecycle Events | Event that runs during each frame, only if a Component and its SceneObject is enabled. |
| LongPressEndEventArgs | Interaction | Arguments used with the InteractionComponent#onLongPressEnd event. |
| LongPressStartEventArgs | Interaction | Arguments used with the InteractionComponent#onLonPressStart event. |
| ManipulateEndEvent | Interaction | This event is triggered when manipulation on the object ends. |
| ManipulateEndEventArgs | Interaction | Arguments used with the ManipulateComponent.onManipulateEnd event. |
| ManipulateStartEvent | Interaction | This event is triggered when manipulation on the object begins. |
| ManipulateStartEventArgs | Interaction | Arguments used with the ManipulateComponent.onManipulateStart event. |
| MessageEvent | Lifecycle Events | Event fired when a message is received from the host (Lens Studio or an AI agent). |
| MouthClosedEvent | AR & Tracking › Face | Triggered when the tracked face's mouth closes. |
| MouthOpenedEvent | AR & Tracking › Face | Triggered when the tracked face's mouth opens. |
| OnAwakeEvent | Lifecycle Events | Event that runs immediately when a Component is constructed or deserialized. |
| OnDestroyEvent | Lifecycle Events | Event that runs when a Component will be destroyed. |
| OnDidEnterForegroundEvent | Lifecycle Events | Triggered when the Lens has entered the Foreground phase. |
| OnDidEnterSuspendedEvent | Lifecycle Events | Triggered when the Lens has entered the Suspended phase. |
| OnDisableEvent | Lifecycle Events | Event that runs when a Component becomes disabled, either directly via its own Component.enabled property or because its SceneObject becomes disabled. |
| OnEnableEvent | Lifecycle Events | Event that runs when a Component becomes enabled, either directly via its own Component.enabled property or because its SceneObject becomes enabled. |
| OnFullScreenEnterEvent | Lifecycle Events | Triggered immediately when the Lens enters full-screen mode. |
| OnFullScreenExitEvent | Lifecycle Events | Triggered when the Lens returns to the standard UI with carousel and other Snapchat UI elements. |
| OnPauseEvent | Lifecycle Events | Triggered when users tap the menu button in Palm UI. |
| OnResumeEvent | Lifecycle Events | Triggered when users tap the menu button in Palm UI during pause state. |
| OnStartEvent | Lifecycle Events | Runs on the first frame a Component is enabled, at a later point than OnAwakeEvent but guaranteed within the first frame before rendering. |
| OnTimeStartEvent | Lifecycle Events | The base class for scenewide events. |
| OnWillEnterForegroundEvent | Lifecycle Events | Triggered when the Lens is about to enter the Foreground phase. |
| OnWillEnterSuspendedEvent | Lifecycle Events | Triggered when the Lens is about to enter the Suspended phase. |
| OverlapEnterEventArgs | Physics › Collisions & Overlaps | Args used for ColliderComponent.onOverlapEnter, which is triggered when the collider begins overlapping another object. |
| OverlapExitEventArgs | Physics › Collisions & Overlaps | Args used for ColliderComponent.onOverlapExit, which is triggered when the collider stops overlapping another object. |
| OverlapStayEventArgs | Physics › Collisions & Overlaps | Args used for ColliderComponent.onOverlapStay, which is triggered every frame while the collider continues overlapping another object. |
| PalmTapDownArgs | Interaction | The arguments of the PalmTapDown event on GestureModule |
| PalmTapUpArgs | Interaction | The arguments of the PalmTapUp event on GestureModule |
| PanEndEventArgs | Interaction | Arguments used with the InteractionComponent#onPanEnd event. |
| PanGestureEndEvent | Interaction | Triggered when a pan gesture ends. |
| PanGestureMoveEvent | Interaction | Triggered while the user is panning. |
| PanGestureStartEvent | Interaction | Triggered when a pan gesture starts. |
| PanMoveEventArgs | Interaction | Arguments used with the InteractionComponent#onPanMove event. |
| PanStartEventArgs | Interaction | Arguments used with the InteractionComponent#onPanStart event. |
| PinchDownArgs | Interaction | The arguments of the PinchDown event on GestureModule |
| PinchEndEventArgs | Interaction | Arguments used with the InteractionComponent#onPinchEnd event. |
| PinchGestureEndEvent | Interaction | Triggered when a pinch gesture ends. |
| PinchGestureMoveEvent | Interaction | Triggered while the user is pinching. |
| PinchGestureStartEvent | Interaction | Triggered when a pinch gesture starts. |
| PinchMoveEventArgs | Interaction | Arguments used with the InteractionComponent#onPinchMove event. |
| PinchStartEventArgs | Interaction | Arguments used with the InteractionComponent#onPinchStart event. |
| PinchStrengthArgs | Interaction | The arguments of the PinchStrength event on GestureModule |
| PinchUpArgs | Interaction | The arguments of the PinchUp event on GestureModule |
| SceneEvent | Lifecycle Events | The base class for scenewide events. |
| SceneObjectEvent | Lifecycle Events | Base class for all object-based Event types in Lens Studio (ManipulateStartEvent, TapEvent, etc.). |
| ScrollEndEventArgs | Interaction | Arguments used with the InteractionComponent#onScrollEnd event. |
| ScrollEventArgs | Interaction | Arguments used with the InteractionComponent#onScroll event. |
| ScrollStartEventArgs | Interaction | Arguments used with the InteractionComponent#onScrollStart event. |
| SelectEndEventArgs | Interaction | Arguments used with the InteractionComponent.onSelectEnd event. |
| SelectStartEventArgs | Interaction | Arguments used with the InteractionComponent.onSelectStart event. |
| SmileFinishedEvent | AR & Tracking › Face | Triggered when a smile ends on the tracked face. |
| SmileStartedEvent | AR & Tracking › Face | Triggered when a smile begins on the tracked face. |
| SnapImageCaptureEvent | Lifecycle Events | Called when the user taps on the capture button to record an image. |
| SnapRecordStartEvent | Lifecycle Events | Gets called when the user starts long pressing the capture button to record a Snap. |
| SnapRecordStopEvent | Lifecycle Events | Gets called when the user stops long pressing the Snap button to end recording of a Snap. |
| SpecsInteractionModule.OverlapEnterEventArgs | Interaction › SpecsInteractionModule | Args for OverlapProbe#onOverlapEnter, delivered once per frame: enteredOverlaps, every membership that entered the probe's volume this frame. |
| SpecsInteractionModule.OverlapExitEventArgs | Interaction › SpecsInteractionModule | Args for OverlapProbe#onOverlapExit, delivered once per frame: exitedOverlaps, every membership that left the probe's volume this frame (or whose collider wa… |
| SurfaceTouchDataArgs | AR & Tracking › World | |
| TapEvent | Interaction | This event is triggered when the user taps on the screen. |
| TapEventArgs | Interaction | Arguments used with the InteractionComponent.onTap event. |
| TargetingDataArgs | Interaction | |
| TouchEndEvent | Interaction | Triggered when a touch event ends. |
| TouchEndEventArgs | Interaction | Arguments used with the InteractionComponent.onTouchEnd event. |
| TouchMoveEvent | Interaction | Triggered when a touch position on the screen is moved. |
| TouchMoveEventArgs | Interaction | Arguments used with the InteractionComponent.onTouchMove event. |
| TouchStartEvent | Interaction | Triggered when a touch event starts. |
| TouchStartEventArgs | Interaction | Arguments used with the InteractionComponent.onTouchStart event. |
| TriggerPrimaryEvent | Interaction | Gets called when the user triggers the primary input on their device. |
| TriggerPrimaryEventArgs | Interaction | Arguments used with the InteractionComponent.onTriggerPrimary event. |
| TurnOffEvent | Lifecycle Events | Triggered when the lens turns off. |
| UpdateEvent | Lifecycle Events | Event that runs during each frame, only if a Component and its SceneObject is enabled. |
| WorldTrackingMeshesAddedEvent | AR & Tracking › World | Triggered when new world tracking meshes are detected. |
| WorldTrackingMeshesRemovedEvent | AR & Tracking › World | Triggered when some world tracking meshes are no longer detected. |
| WorldTrackingMeshesUpdatedEvent | AR & Tracking › World | Triggered when world tracking meshes are updated. |
| WorldTrackingPlanesAddedEvent | AR & Tracking › World | Triggered when plane(s) are newly detected. |
| WorldTrackingPlanesRemovedEvent | AR & Tracking › World | Triggered when plane(s) are no longer detected. |
| WorldTrackingPlanesUpdatedEvent | AR & Tracking › World | Triggered when currently detected plane(s) are updated. |
| WorldTrackingResetEvent | AR & Tracking › World | If 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… |