Below is a list of all the classes that is a subclass of SceneEvent.
| SceneEvent | Description |
|---|---|
| BrowsLoweredEvent | Triggered when eyebrows are lowered on the tracked face. |
| BrowsRaisedEvent | Triggered when eyebrows are raised on the tracked face. |
| BrowsReturnedToNormalEvent | Triggered when eyebrows are returned to normal on the tracked face. |
| CameraBackEvent | Triggered when the device's back facing camera becomes active. |
| CameraFrontEvent | Triggered when the device's front facing camera becomes active. |
| ConnectedLensEnteredEvent | Event fired when the "Launch connected lens" button was pressed. Wait for this event to be triggered before creating a session, as having this event gaurantees the user has accepted the necessary disclosures to use a connected lens experience. |
| DelayedCallbackEvent | An event that gets triggered after a delay. |
| DoubleTapEvent | Triggered when a double tap event has occurred. |
| FaceFoundEvent | Triggered when a new face is detected and starts being tracked. |
| FaceLostEvent | Triggered when a face can no longer be tracked. For example, if a face gets blocked from the camera's view, or gets too far away. |
| FaceTrackingEvent | This is the base class for all face tracking events. This event won't actually get triggered itself, so use one of the child classes instead. |
| HoverEndEvent | Triggered when hovering state has ended on an InteractionComponent. |
| HoverEvent | Triggered when a mouse hover event occurs. Only triggered in the Preview panel of Lens studio. Useful when working with Spectacles, where you can simulate the use of your hand to hover over an object. Does not get triggered on mobile. |
| HoverStartEvent | Base class for all object-based Event types in Lens Studio (ManipulateStartEvent, TapEvent, etc.). |
| KeyPressEvent | This event is triggered when the user presses a key. |
| KeyReleaseEvent | This event is triggered when the user releases a key. |
| KissFinishedEvent | Triggered when the tracked face ends a kiss. |
| KissStartedEvent | Triggered when the tracked face starts a kiss. |
| LateUpdateEvent | Event that runs during each frame, only if a Component and its SceneObject is enabled. LateUpdate runs later in the frame, after all UpdateEvents have run, and after systems like animation, physics, and tracking but before the start of rendering. A Component will not get a LateUpdateEvent that frame if it constructed after UpdateEvents have started to be processed. Relative ordering between LateUpdateEvents is not guaranteed. |
| ManipulateEndEvent | This event is triggered when manipulation on the object ends. |
| ManipulateStartEvent | This event is triggered when manipulation on the object begins. |
| MouthClosedEvent | Triggered when the tracked face's mouth closes. |
| MouthOpenedEvent | Triggered when the tracked face's mouth opens. |
| OnAwakeEvent | Event that runs immediately when a Component is constructed or deserialized. Will run before a call like SceneObject.createComponent or ObjectPrefab.instantiate returns. When multiple Components are constructed together, such as during Scene loading or ObjectPrefab instantiation, OnAwake events will run in hierarchy order. If a Component is disabled in the hierarchy at those points -- including because its SceneObject is disabled -- then OnAwake will not run, and will instead run immediately the first time the Component is enabled. |
| OnDestroyEvent | Event that runs when a Component will be destroyed. All OnDestroy events will run prior to any SceneObjects or Components actually being destroyed, however it is disallowed to reparent a SceneObject either under the SceneObject being destroyed or out from under a SceneObject being destroyed. Destroying an ancestor or descendent SceneObject during OnDestroy will queue that destruction to only be processed once the current destruction completes. |
| OnDisableEvent | Event that runs when a Component becomes disabled, either directly via its own Component.enabled property or because its SceneObject becomes disabled. OnDisableEvent will run after the SceneObject's own SceneObject.onDisabled event property and will not run if some listener to that event enabled the SceneObject again. All of a SceneObject's Components then receive OnDisableEvent before child SceneObjects begin to receive SceneObject.onDisabled and OnDisableEvents. |
| OnEnableEvent | Event that runs when a Component becomes enabled, either directly via its own Component.enabled property or because its SceneObject becomes enabled. OnEnableEvent will run after the SceneObject's own SceneObject.onEnabled event property and will not run if some listener to that event disabled the SceneObject again. All of a SceneObject's Components then receive OnEnableEvent before child SceneObjects begin to receive SceneObject.onEnabled and OnEnableEvents. |
| OnPauseEvent | Triggered when users tap the menu button in Palm UI. When paused, certain behaviors like animations or script updates continue running in the background, while inputs (e.g., Hand Tracking, Mobile Controller) are disabled to allow the system overlay to take priority. Developers should manage scenarios where the Lens is paused to maintain a seamless experience. |
| OnResumeEvent | Triggered when users tap the menu button in Palm UI during pause state. When paused, certain behaviors like animations or script updates continue running in the background, while inputs (e.g., Hand Tracking, Mobile Controller) are disabled to allow the system overlay to take priority. Developers should manage scenarios where the Lens is resumed after pause to maintain a seamless experience. |
| OnStartEvent | Runs on the first frame a Component is enabled, at a later point than OnAwakeEvent but guaranteed within the first frame before rendering. For Components constructed because of a scripting call like SceneObject.createComponent or ObjectPrefab.instantiate the OnStart event will run after those functions have returned and the calling scope has exited. Relative order of OnStart events between multiple Components constructed together (such as in initial SceneLoading or ObjectPrefab instantiation) is not guaranteed. |
| OnTimeStartEvent | The base class for scenewide events. SceneEvents can be created using ScriptComponent's ScriptComponent#createEvent method. |
| SceneObjectEvent | Base class for all object-based Event types in Lens Studio (ManipulateStartEvent, TapEvent, etc.). |
| SmileFinishedEvent | Triggered when a smile ends on the tracked face. |
| SmileStartedEvent | Triggered when a smile begins on the tracked face. |
| SnapImageCaptureEvent | Called when the user taps on the capture button to record an image. |
| SnapRecordStartEvent | Gets called when the user starts long pressing the capture button to record a Snap. |
| SnapRecordStopEvent | Gets called when the user stops long pressing the Snap button to end recording of a Snap. |
| TapEvent | This event is triggered when the user taps on the screen. |
| TouchEndEvent | Triggered when a touch event ends. |
| TouchMoveEvent | Triggered when a touch position on the screen is moved. |
| TouchStartEvent | Triggered when a touch event starts. |
| TriggerPrimaryEvent | Gets called when the user triggers the primary input on their device. For example touch on touch screens. |
| TurnOffEvent | Triggered when the lens turns off. |
| TurnOnEvent | This event has been deprecated, please use the OnStartEvent instead. Triggered when the lens turns on. |
| UpdateEvent | Event that runs during each frame, only if a Component and its SceneObject is enabled. A Component will not get an UpdateEvent that frame if it constructed after UpdateEvents have started to be processed. Relative ordering between UpdateEvents is not guaranteed. |
| WorldTrackingMeshesAddedEvent | Triggered when new world tracking meshes are detected. Only available when a Device Tracking component is in the scene, and world mesh tracking is supported and enabled. In addition, DeviceTracking component must be set to World mode to orient the Camera relative to the mesh correctly. |
| WorldTrackingMeshesRemovedEvent | Triggered when some world tracking meshes are no longer detected. Only available when a Device Tracking component is in the scene, and world mesh tracking is supported and enabled. |
| WorldTrackingMeshesUpdatedEvent | Triggered when world tracking meshes are updated. Only available when a Device Tracking component is in the scene, and world mesh tracking is supported and enabled. |
| WorldTrackingPlanesAddedEvent | Triggered when plane(s) are newly detected. The worldOptions.nativePlaneTrackingType must be set to anything other than NativePlaneTrackingType.None. In addition, DeviceTracking component must be set to World mode to orient the Camera relative to the planes correctly. |
| WorldTrackingPlanesRemovedEvent | Triggered when plane(s) are no longer detected. This usually happens when two planes merge into one. Planes persist when no longer seen by camera(s) and when previously detected objects move (e.g. a door is opened) to create a static scene. DeviceTracking component must be set to World mode to orient the Camera relative to the planes correctly. |
| WorldTrackingPlanesUpdatedEvent | Triggered when currently detected plane(s) are updated. This usually happens when a plane grows in size. The worldOptions.nativePlaneTrackingType must be set to anything other than NativePlaneTrackingType.None. In addition, DeviceTracking component must be set to World mode to orient the Camera relative to the planes correctly. |
| WorldTrackingResetEvent | 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 taps the ground). |