Worlds TS API Reference Guide
APIs Documentation Link: Worlds API Reference
Creator Manual: Horizon Worlds Creator Manual
| API Name | Description | Links |
|---|---|---|
| core | Base scripting system that powers all interactive behaviors through components, events, classes and types | Horizon Worlds: API Reference |
| analytics | Allows creators to capture and send custom in world analytics events, helping track player behavior, engagement, and performance metrics | Capturing Custom In-World Analytics |
| avatar_ai_agent | Provides functionality for creating and controlling scripted avatar NPCs | API Overview for Scripted Avatar NPCs |
| camera* | Gives access to camera controls, enabling custom perspectives, screenshots, and cinematic sequences.Not compatible with VR | Meta for Developers: Camera |
| mobile_gestures* | Detects and responds to touch gestures like taps and swipes | Meta for Developers: Gestures |
| navmesh | Enables AI or NPCs to navigate complex 3D environments by generating and following navigation meshes | Navigation mesh generation |
| noesis | Provides tools for creating and rendering advanced UI layouts using Noesis Studio | Meta for Developers: Noesis |
| npc | Controls non player characters, and LLM interactions. | Scripted NPCs |
| performance | Allows you to add custom performance metrics to Perfetto traces | Custom Metrics API |
| API Name | Description | Links |
|---|---|---|
| portrait_camera | Detects the current orientation of the player’s camera according to the world configuration (portrait or landscape) | Portrait Camera API |
| social | Connects worlds with player social profiles | Social Following for Instagram and Horizon |
| ui | Used to build custom user interfaces, buttons, and overlays | Create a custom UI panel |
| unity_asset_bundle | Interacts with Unity asset bundles characters, allowing for ad-hoc animations. These characters can be found in the Public Asset Library | UAB NPCs |
| world_streaming | Manages loading and unloading of world sections dynamically to optimize performance and design experiences beyond the world capacity | World Streaming |