Studio Events Reference
Events are a core part of building dynamic and interactive experiences in Studio. This reference outlines the different types of events you can listen for in your projects.
Event Categories
-
XR Events: Events emitted by 8th Wall camera pipeline modules like
reality
andfacecontroller
, covering things like Image Target tracking, VPS location spawning, and Face detection. -
General Events: Core world-level events triggered within Studio experiences, such as active space changes, model loading, animation loops, and audio playback events.
-
Camera Events: Events related to camera state changes, including active camera switches, XR camera attribute edits, and active camera entity changes.
-
Input Events: Events triggered by user interactions, including touch, gesture, and UI click events. Covers both simple taps and complex multi-touch gestures.
-
Physics Events: Events emitted when physical interactions occur between entities, such as collisions starting or ending.
Each event section provides:
- A description of when the event is emitted
- Properties (if any) passed with the event
- Code examples showing how to listen for the event globally or on specific entities