### UIComponent Methods: initializeUI and start Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/ui_uicomponent Details the `initializeUI` and `start` methods for UI components. `initializeUI` defines the UI and sets up event subscriptions before `start`. `start` provides a default implementation for UIComponent subclasses. ```APIDOC initializeUI(): UINode - Defines the UI and sets up necessary event subscriptions. - Called before the UIComponent.start() method when the component is started. - Returns: A valid UINode. start(): void - A default start implementation for classes that inherit from UIComponent. - Returns: void. ``` -------------------------------- ### Core Components and Gizmos Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/capturing_startvideocaptureoptions Documentation for core components and gizmos within the Meta Horizon Worlds engine, including BaseTestComponent, Component, AIAgentGizmo, AchievementsGizmo, AnimatedEntity, Asset, AssetContentData, AssetPoolGizmo, AttachableEntity, and AudioGizmo. ```APIDOC core: - Core functionalities of the engine. Abstract Classes: - Abstract base classes for engine components. BaseTestComponent: - Base class for test components. Component: - Base class for all engine components. Classes: - Various classes representing engine entities and functionalities. AIAgentGizmo: - Gizmo for AI agent interactions. AchievementsGizmo: - Gizmo for managing achievements. AnimatedEntity: - Represents an entity with animation capabilities. Asset: - Represents a generic asset in the engine. AssetContentData: - Data structure for asset content. AssetPoolGizmo: - Gizmo for managing asset pools. AttachableEntity: - Represents an entity that can be attached to another. AudioGizmo: - Gizmo for audio-related functionalities. ``` -------------------------------- ### Meta Horizon Worlds Analytics Payloads Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_infoslide Documentation for various payload structures used in Meta Horizon Worlds analytics events. These include payloads for section starts and ends, stage starts and ends, task starts and ends, task step starts and ends, weapon interactions, and wearable item interactions. ```APIDOC SectionStartPayload: description: Payload for the start of a section. StageEndPayload: description: Payload for the end of a stage. StageStartPayload: description: Payload for the start of a stage. TaskEndPayload: description: Payload for the end of a task. TaskStartPayload: description: Payload for the start of a task. TaskStepEndPayload: description: Payload for the end of a task step. TaskStepStartPayload: description: Payload for the start of a task step. WeaponEquipPayload: description: Payload for equipping a weapon. WeaponGrabPayload: description: Payload for grabbing a weapon. WeaponReleasePayload: description: Payload for releasing a weapon. WearableEquipPayload: description: Payload for equipping a wearable item. WearableReleasePayload: description: Payload for releasing a wearable item. Turbo: description: Information related to Turbo functionality. TurboDataService: description: Data service for Turbo. TurboDefaultSettings: description: Default settings for Turbo. TurboEvents: description: Events related to Turbo. ``` -------------------------------- ### Core Default Options and Helpers Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/ui_animation_2 Provides access to default configuration options for throwing and tooltips, along with helper functions for in-world shops and predefined constants for game limits. ```APIDOC DefaultThrowOptions: Description: Configuration options for default throw behavior. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_defaultthrowoptions DefaultTooltipOptions: Description: Configuration options for default tooltip display. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_defaulttooltipoptions InWorldShopHelpers: Description: Helper functions for managing in-world shops. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_inworldshophelpers LEADEBOARD_SCORE_MAX_VALUE: Description: Constant defining the maximum value for leaderboard scores. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_leadeboard_score_max_value PVAR_CHARACTER_LIMIT: Description: Constant defining the character limit for PVars. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_pvar_character_limit PropTypes: Description: Definitions for various property types used in the system. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_proptypes VoipSettingValues: Description: Defines possible values for Voice over IP (VoIP) settings. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_voipsettingvalues ``` -------------------------------- ### HorizonPerformanceMetricConfig Example Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/performance_horizonperformancemetricconfig Example demonstrating how to instantiate and configure a HorizonPerformanceMetricConfig for tracking hit counts. ```javascript const hitCounterMetric =new HorizonPerformanceMetricConfig("totalHitCounterMetric",["normalHit","glancingHit","criticalHit"],HorizonTraceEventType.Counter,"50"); ``` -------------------------------- ### Core Components and Options Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/capturing_defaultstartvideocaptureoptions Documentation for various core components and configuration options used within Meta Horizon Worlds. This includes constructors, dispose operations, raycast hits, and various settings for interactions, visuals, and player controls. ```APIDOC ComponentWithConstructor: Description: Represents a component that can be constructed. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_componentwithconstructor DisposeOperation: Description: Defines an operation for disposing of resources. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_disposeoperation EntityRaycastHit: Description: Information about a raycast hit on an entity. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_entityraycasthit FetchAsDataOptions: Description: Options for fetching data. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_fetchasdataoptions FindEntitiesOptions: Description: Options for finding entities. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_findentitiesoptions FocusUIOptions: Description: Options for focusing UI elements. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_focusuioptions FocusedInteractionOptions: Description: Options for focused interactions. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_focusedinteractionoptions FocusedInteractionTapOptions: Description: Options for tapping focused interactions. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_focusedinteractiontapoptions FocusedInteractionTrailOptions: Description: Options for trailing focused interactions. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_focusedinteractiontrailoptions InWorldPurchasable: Description: Represents an item available for in-world purchase. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_inworldpurchasable InWorldPurchasablePrice: Description: Details about the price of an in-world purchasable item. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_inworldpurchasableprice InfoSlide: Description: Represents an informational slide. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_infoslide InfoSlideStyle: Description: Styling options for an informational slide. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_infoslidestyle InteractionInfo: Description: Information related to an interaction. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_interactioninfo LaunchProjectileOptions: Description: Options for launching a projectile. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_launchprojectileoptions OnPlayerPurchasedItemEventPayload: Description: Payload for the event when a player purchases an item. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_onplayerpurchaseditemeventpayload ParticleFXPlayOptions: Description: Options for playing Particle FX. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_particlefxplayoptions ParticleFXSetParameterOptions: Description: Options for setting parameters of Particle FX. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_particlefxsetparameteroptions ParticleFXStopOptions: Description: Options for stopping Particle FX. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_particlefxstopoptions PersistentSerializableState: Description: Represents a persistent state that can be serialized. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_persistentserializablestate PlayAnimationOptions: Description: Options for playing animations. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_playanimationoptions PlayAvatarGripPoseAnimationOptions: Description: Options for playing avatar grip pose animations. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_playavatargripposeanimationoptions PlayerControlsConnectOptions: Description: Options for connecting player controls. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_playercontrolsconnectoptions PlayerInputStateChangeCallback: Description: Callback for player input state changes. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_playerinputstatechangecallback PlayerRaycastHit: Description: Information about a raycast hit from a player. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_playerraycasthit PopupOptions: Description: Options for displaying a popup. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_popupoptions PropsDefinitionFromComponent: Description: Defines properties derived from a component. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_propsdefinitionfromcomponent PropsFromDefinitions: Description: Properties derived from definitions. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_propsfromdefinitions RaycastHit: Description: General information about a raycast hit. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_raycasthit RaycastOptions: Description: Options for performing a raycast. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_raycastoptions SerializableState: Description: Represents a state that can be serialized. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_serializablestate SetMaterialOptions: Description: Options for setting material properties. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_setmaterialoptions SetMeshOptions: Description: Options for setting mesh properties. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_setmeshoptions SetTextureOptions: Description: Options for setting texture properties. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_settextureoptions SpringOptions: Description: Options for configuring spring physics. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_springoptions StaticRaycastHit: Description: Information about a raycast hit on static geometry. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_staticraycasthit StopAnimationOptions: Description: Options for stopping animations. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_stopanimationoptions ThrowOptions: Description: Options for throwing objects. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_throwoptions TooltipLineAttachmentProperties: Description: Properties for attaching tooltip lines. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_tooltiplineattachmentproperties TooltipOptions: Description: Options for displaying tooltips. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_tooltipoptions VFXParameter: Description: Represents a parameter for Visual Effects (VFX). URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_vfxparameter VFXParameterType: Description: Defines the type of a VFX parameter. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_vfxparametertype VoipSetting: Description: Settings for Voice over IP (VoIP). URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_voipsetting Variables: Description: General variables, potentially for capture options. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/capturing_defaultstartvideocaptureoptions ApiVersion: Description: Information about the API version. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_apiversion CodeBlockEvents: Description: Events related to code blocks. URL: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_codeblockevents ``` -------------------------------- ### Default Start Video Capture Options Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/index Provides default settings for starting video capture. ```APIDOC DefaultStartVideoCaptureOptions: cameraPreset: CameraMovementPreset = FirstPersonMovementCameraMovementPreset() outputFormat: str = 'mp4' quality: int = 80 ``` -------------------------------- ### Default Options and Helpers Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/analytics_gameroundstartforplayerspayload Documentation for various default options and helper classes used in Meta Horizon Worlds, including fetch, find entities, interactions, popups, springs, throws, tooltips, and shop helpers. ```APIDOC DefaultFetchAsDataOptions: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_defaultfetchasdataoptions DefaultFindEntitiesOptions: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_defaultfindentitiesoptions DefaultFocusedInteractionEnableOptions: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_defaultfocusedinteractionenableoptions DefaultFocusedInteractionTapOptions: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_defaultfocusedinteractiontapoptions DefaultFocusedInteractionTrailOptions: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_defaultfocusedinteractiontrailoptions DefaultPopupOptions: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_defaultpopupoptions DefaultSpringOptions: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_defaultspringoptions DefaultThrowOptions: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_defaultthrowoptions DefaultTooltipOptions: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_defaulttooltipoptions InWorldShopHelpers: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_inworldshophelpers ``` -------------------------------- ### Verify Player Entitlement Example Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_worldinventory An example demonstrating how to retrieve a player's entitlements and check if they own a specific item using the WorldInventory class. ```typescript verifyEntitlement(player: hz.Player, itemSKU: string) { const items: PlayerEntitlementDetails[] = await WorldInventory.getPlayerEntitlements(player); const isActive = WorldInventory.DoesPlayerHaveEntitlement(player, itemSKU); console.log(itemSKU, " consumbed item is", isActive, "\n"); } ``` -------------------------------- ### Analytics Task Start Payload Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/analytics_taskstartpayload Defines the structure for the payload used when starting an analytics task, including information about functions and interfaces relevant to analytics tracking. ```APIDOC Functions: Description: Section detailing available functions for analytics. Interfaces: Description: Section detailing interfaces related to analytics. Type Aliases: Description: Section detailing type aliases used in analytics. ``` -------------------------------- ### Core System Components and Gizmos Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_onplayerpurchaseditemeventpayload Documentation for core system components and gizmos, including abstract classes, base test components, general components, and specific gizmos like AIAgentGizmo, AchievementsGizmo, AssetPoolGizmo, and AudioGizmo. ```APIDOC BaseTestComponent: - Base class for test components. Component: - General component interface. AIAgentGizmo: - Gizmo for AI agents. AchievementsGizmo: - Gizmo for managing achievements. AnimatedEntity: - Represents an animated entity. Asset: - Represents an asset. AssetContentData: - Data structure for asset content. AssetPoolGizmo: - Gizmo for managing asset pools. AttachableEntity: - Represents an entity that can be attached. AudioGizmo: - Gizmo for audio functionalities. ``` -------------------------------- ### Meta Horizon Worlds API Reference - Core SpawnpointGizmo Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_spawnpointgizmo Documentation for the core_spawnpointgizmo in Meta Horizon Worlds API v2.0.0. This section likely details components related to game world setup and entity placement. ```APIDOC core_spawnpointgizmo: - Classes - Enumerations - Interfaces ``` -------------------------------- ### Component Registration Example Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_component An example demonstrating how to extend the Component class to create a new component type (NpcItem) and register it with the Horizon Worlds system. ```typescript import * as hz from 'horizon/core'; class NpcItem extends hz.Component { static propsDefinition = {}; start() { // Component initialization logic } } hz.Component.register(NpcItem); ``` -------------------------------- ### Component start() Method Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_component The abstract 'start' method for components in Meta Horizon Worlds. It is called when the component begins running, and is the appropriate place to add event listeners. ```typescript abstract start(): void; // Called when the component starts running. Add event listeners here. ``` -------------------------------- ### Meta Horizon Worlds UI Components and Bindings Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_spawnstate Documentation for UI components, bindings, and related types in Meta Horizon Worlds. ```APIDOC UI Components: - ui_animation_2 - ui_uicomponent - ui_valuebindingbase - ui_animatedbinding - ui_animatedinterpolation - ui_binding - ui_easing - ui_imagesource - ui_uigizmo - ui_uinode - ui_avatarimageexpressions - ui_dynamiclist - ui_image_2 - ui_pressable - ui_scrollview - ui_text_2 - ui_view Type Aliases: - ui_bindable - ui_bindingset - ui_borderstyle - ui_callback - ui_callbackmap - ui_callbackwithpayload - ui_colorvalue - ui_conditionalprops - ui_dimensionvalue - ui_dynamiclistprops - ui_fontfamily - ui_imageprops - ui_imagestyle - ui_layoutstyle - ui_pressableprops - ui_scrollviewprops - ui_shadowstyle - ui_textprops - ui_textstyle - ui_timinganimationconfig - ui_transformstyle - ui_uichildren - ui_viewprops - ui_viewstyle ``` -------------------------------- ### Gestures Class Usage Example Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/mobile_gestures_gestures An example demonstrating how to instantiate and use the Gestures class to handle tap, long tap, swipe, and pinch gestures within a Horizon Worlds component. ```typescript import { Gestures } from 'horizon/mobile_gestures'; class MyComponent extends Component { gestures = new Gestures(this); start() { const player = this.entity.owner.get(); player.enterFocusedInteractionMode(); this.gestures.onTap.connectLocalEvent(({ touches }) => { console.log('tap', touches[0].current.screenPosition); }); this.gestures.onLongTap.connectLocalEvent(({ touches }) => { console.log('long tap', touches[0].current.screenPosition); }); this.gestures.onSwipe.connectLocalEvent(({ swipeDirection }) => { console.log('swipe', swipeDirection); }); this.gestures.onPinch.connectLocalEvent(({ scale, rotate }) => { console.log('pinch', scale, rotate); }); } } ``` -------------------------------- ### Gizmo Specifics API Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_radianstodegrees Detailed API documentation for specific gizmos like ProjectileLauncherGizmo and SpawnController. ```APIDOC ProjectileLauncherGizmo: Description: Gizmo for launching projectiles. Methods: - launch(direction: Vec3, force: float): void SpawnController: Description: Manages entity spawning. Methods: - spawn(): Entity SpawnControllerBase: Description: Base class for spawn controllers. IWPSellerGizmo: Description: Gizmo for in-world purchase sellers. ``` -------------------------------- ### Core Interfaces Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_spawnstate Documentation for key interfaces in the Meta Horizon Worlds API, enabling interaction with various systems like leaderboards, persistent storage, and UI elements. Includes ILeaderboards, IPersistentStorage, IPersistentStorageWorld, ITeam, and IUI. ```APIDOC ILeaderboards: Interface for accessing and managing leaderboards. IPersistentStorage: Interface for persistent data storage. IPersistentStorageWorld: Interface for world-specific persistent data storage. ITeam: Interface for managing player teams. IUI: Interface for interacting with the user interface. ``` -------------------------------- ### Get MeshEntity String Representation Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_meshentity Retrieves a human-readable string representation of the MeshEntity. ```APIDOC toString(): string; Returns: string - A string representation of the MeshEntity. ``` -------------------------------- ### Capturing API Reference Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/mobile_gestures_touchstate Details on starting and stopping video capture, including options and notifications. ```APIDOC PlayerCapturing: Description: Manages video capturing for players. Methods: - StartVideoCapture(options: StartVideoCaptureOptions): VideoCaptureResponseCode - StopVideoCapture(options: StopVideoCaptureOptions): VideoCaptureResponseCode VideoCaptureNotifications: Description: Notifications related to video capture events. Events: - OnCaptureStarted: void - OnCaptureStopped: void - OnCaptureError: VideoCaptureResponseCode VideoCaptureResponseCode: Description: Codes indicating the result of a video capture operation. Values: - SUCCESS: 0 - ERROR_ALREADY_CAPTURING: 1 - ERROR_NOT_CAPTURING: 2 - ERROR_INVALID_OPTIONS: 3 - ERROR_UNKNOWN: 4 CameraMovementPreset: Description: Base type for camera movement presets. FirstPersonMovementCameraMovementPreset: Description: Preset for first-person camera movement. Inherits: CameraMovementPreset FixedPositionTrackingPlayerCameraMovementPreset: Description: Preset for a camera fixed to a player's position. Inherits: CameraMovementPreset Properties: - targetPlayerId: string StartVideoCaptureOptions: Description: Options for starting video capture. Properties: - fileName: string (The name of the video file) - cameraPreset: CameraMovementPreset (The camera movement preset to use) - maxDuration: number (Optional: Maximum duration in seconds) StopVideoCaptureOptions: Description: Options for stopping video capture. Properties: - None ThirdPersonOverShoulderCameraMovementPreset: Description: Preset for a third-person over-the-shoulder camera. Inherits: CameraMovementPreset Properties: - targetPlayerId: string - offset: Vector3 DefaultStartVideoCaptureOptions: Description: Default options for starting video capture. Inherits: StartVideoCaptureOptions Default Values: - fileName: "default_capture.mp4" - cameraPreset: FirstPersonMovementCameraMovementPreset DefaultStopVideoCaptureOptions: Description: Default options for stopping video capture. Inherits: StopVideoCaptureOptions Default Values: - None ``` -------------------------------- ### UI Components and Bindings Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_launchprojectileoptions Documentation for UI components, animations, bindings, and related properties and styles in Meta Horizon Worlds. ```APIDOC Animation_2: - Represents animation configurations. UIComponent: - Base component for UI elements. ValueBindingBase: - Base class for value bindings. AnimatedBinding: - Binding that supports animation. AnimatedInterpolation: - Interpolation logic for animations. Binding: - Represents a data binding. Easing: - Defines easing functions for animations. ImageSource: - Specifies the source for images. UIGizmo: - Gizmo component for UI elements. UINode: - Represents a node in the UI hierarchy. AvatarImageExpressions: - Defines expressions for avatar images. DynamicList: - Component for displaying dynamic lists. Image_2: - Represents an image component. Pressable: - Component for pressable UI elements. ScrollView: - Component for scrollable views. Text_2: - Represents a text component. View: - Base component for views. Bindable: - Interface for bindable objects. BindingSet: - A set of bindings. BorderStyle: - Defines border styles. Callback: - Represents a callback function. CallbackMap: - A map of callbacks. CallbackWithPayload: - Callback function with a payload. ColorValue: - Represents a color value. ConditionalProps: - Props that are applied conditionally. DimensionValue: - Represents a dimension value (e.g., width, height). DynamicListProps: - Properties for DynamicList. FontFamily: - Defines font families. ImageProps: - Properties for Image components. ImageStyle: - Styles for Image components. LayoutStyle: - Defines layout styles. PressableProps: - Properties for Pressable components. ScrollViewProps: - Properties for ScrollView components. ShadowStyle: - Defines shadow styles. TextProps: - Properties for Text components. TextStyle: - Styles for Text components. TimingAnimationConfig: - Configuration for timing-based animations. TransformStyle: - Defines transform styles. UIChildren: - Represents children of a UI component. ViewProps: - Properties for View components. ViewStyle: - Styles for View components. ``` -------------------------------- ### Default Options and Helpers Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/camera_followcameramode Provides default configuration options for various UI elements and helper functions for in-world shops. ```APIDOC DefaultPopupOptions: Description: Default options for popup elements. DefaultSpringOptions: Description: Default options for spring animations. DefaultThrowOptions: Description: Default options for throw mechanics. DefaultTooltipOptions: Description: Default options for tooltip displays. InWorldShopHelpers: Description: Helper functions for managing in-world shops. ``` -------------------------------- ### Start Video Capture Options Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/index Specifies options for initiating video capture. ```APIDOC StartVideoCaptureOptions: cameraPreset: CameraMovementPreset The camera movement preset to use. outputFormat: str The desired output format (e.g., 'mp4'). quality: int The quality setting for the video. ``` -------------------------------- ### Default Capture Options Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_horizonreferenceproperty Provides default options for starting and stopping video capture. ```APIDOC DefaultStartVideoCaptureOptions: Default options for starting video capture. DefaultStopVideoCaptureOptions: Default options for stopping video capture. ``` -------------------------------- ### Spawn and Seller Gizmos Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_class Documentation for spawn-related gizmos and seller gizmos, including SpawnController, SpawnControllerBase, SpawnPointGizmo, and IWPSellerGizmo. ```APIDOC SpawnController: Controls the spawning of entities. SpawnControllerBase: Base class for spawn controllers. SpawnPointGizmo: Defines points where entities can spawn. IWPSellerGizmo: Gizmo for in-world purchase sellers. ``` -------------------------------- ### ImageSource fromTextureAsset Method Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/ui_imagesource Gets an ImageSource based on a provided texture asset. ```typescript static fromTextureAsset(texture: TextureAsset): ImageSource; Parameters: texture: TextureAsset - The texture asset to use as the source. Returns: ImageSource - The image source for the given texture asset. ``` -------------------------------- ### Core Components and Gizmos Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_defaultfetchasdataoptions Documentation for core components and gizmos within the Meta Horizon Worlds framework. Includes base classes, abstract classes, and specific gizmos for AI agents, achievements, assets, audio, and avatar poses. ```APIDOC BaseTestComponent: - Base class for test components. Component: - The fundamental base class for all components. AIAgentGizmo: - Gizmo for AI agent interactions. AchievementsGizmo: - Gizmo for managing achievements. AnimatedEntity: - Represents an entity with animation capabilities. Asset: - Represents a generic asset. AssetContentData: - Data structure for asset content. AssetPoolGizmo: - Gizmo for managing asset pools. AttachableEntity: - Represents an entity that can be attached to another. AudioGizmo: - Gizmo for audio-related functionalities. AvatarPoseGizmo: - Gizmo for managing avatar poses. ``` -------------------------------- ### Video Capture Options Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/world_streaming_sublevelstates Options for starting and stopping video capture, including default configurations. ```APIDOC StartVideoCaptureOptions: - DefaultStartVideoCaptureOptions StopVideoCaptureOptions: - DefaultStopVideoCaptureOptions ``` -------------------------------- ### Core Default Options and Helpers Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_monetizationtimeoption Provides access to default configuration options for popups, springs, throws, and tooltips, along with utility helpers for in-world shops and constants for character limits and leaderboard scores. ```APIDOC DefaultPopupOptions: Description: Configuration options for default popup behavior. DefaultSpringOptions: Description: Configuration options for default spring physics. DefaultThrowOptions: Description: Configuration options for default throw mechanics. DefaultTooltipOptions: Description: Configuration options for default tooltip display. InWorldShopHelpers: Description: Utility functions for managing in-world shops. LEADEBOARD_SCORE_MAX_VALUE: Description: Constant representing the maximum possible score value for leaderboards. PVAR_CHARACTER_LIMIT: Description: Constant defining the maximum character limit for player variables. ``` -------------------------------- ### Core Interfaces for Object Management Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_spawnstate Documentation for interfaces related to object management and lifecycle in Meta Horizon Worlds, including Comparable, Copyable, DisposableObject, and DisposeOperationRegistration. ```APIDOC Comparable: Interface for objects that can be compared. Copyable: Interface for objects that can be copied. DisposableObject: Interface for objects that can be disposed. DisposeOperationRegistration: Registration for a dispose operation. ``` -------------------------------- ### Video Capture Functionality Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/capturing_cameramovementpreset API details for starting, stopping, and managing video capture sessions. ```APIDOC PlayerCapturing: - Manages video capture for players. StartVideoCaptureOptions: - Defines parameters for initiating a video capture. - May include resolution, frame rate, and encoding settings. DefaultStartVideoCaptureOptions: - Default options for starting video capture. StopVideoCaptureOptions: - Defines parameters for stopping a video capture. DefaultStopVideoCaptureOptions: - Default options for stopping video capture. VideoCaptureNotifications: - Notifications related to the video capture process. VideoCaptureResponseCode: - Enumeration of response codes for video capture operations. ``` -------------------------------- ### Analytics and Payload Types Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/analytics_roundstartpayload Types and structures related to game analytics and round start payloads. ```APIDOC Functions: Description: Placeholder for functions related to analytics. Interfaces: Description: Placeholder for interfaces related to analytics. Type Aliases: Description: Placeholder for type aliases related to analytics. ``` -------------------------------- ### Horizon Worlds Gizmos and Controllers Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_interactioninfo Documentation for various gizmos and controllers like ParticleGizmo, RaycastGizmo, SpawnController, and TextGizmo. ```APIDOC ParticleGizmo: Description: Gizmo for managing particle effects. RaycastGizmo: Description: Gizmo for performing raycasts. SpawnController: Description: Controls the spawning of entities. SpawnControllerBase: Description: Base class for spawn controllers. SpawnPointGizmo: Description: Gizmo representing a spawn point. TextGizmo: Description: Gizmo for displaying text. ``` -------------------------------- ### Core Functionalities and Gizmos Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_spawnpointgizmo Documentation for core functionalities and gizmos in Meta Horizon Worlds, including SpawnPointGizmo and Unity Asset Bundles. ```APIDOC SpawnPointGizmo: - A gizmo for defining spawn points. - Properties: - position: { x: number, y: number, z: number } - rotation: { x: number, y: number, z: number, w: number } UnityAssetBundles: - Handles Unity asset bundles. AssetBundleGizmo: - A gizmo related to asset bundles. AssetBundleInstanceReference: - A reference to an asset bundle instance. ``` -------------------------------- ### Color String Representation Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_color Provides a method to get a string representation of the RGB color components. ```APIDOC Color: toString():string Gets a string listing the RGB color components. Returns: A list of the components. ``` -------------------------------- ### Horizon Worlds Other Core Components API Reference Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/avatar_ai_agent_agentlocomotionoptions API documentation for SpawnControllerBase and SpawnPointGizmo. ```APIDOC SpawnControllerBase: Description: Base class for spawn controllers. SpawnPointGizmo: Description: Gizmo for defining spawn points. Properties: spawnPosition: Vec3 spawnRotation: Quaternion ``` -------------------------------- ### Video Capture Options Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/analytics_taskstepstartpayload Specifies options for starting and stopping video capture, including default configurations. ```APIDOC StartVideoCaptureOptions: - Options for initiating video capture. StopVideoCaptureOptions: - Options for terminating video capture. DefaultStartVideoCaptureOptions: - Default options for starting video capture. DefaultStopVideoCaptureOptions: - Default options for stopping video capture. ``` -------------------------------- ### Core Default Options and Helpers Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/editor_editortext Provides access to default configuration options for throwing and tooltips, along with helper functions for in-world shops and predefined constants for game limits. ```APIDOC DefaultThrowOptions: - Description: Configuration options for default throw behavior. - Related: DefaultTooltipOptions DefaultTooltipOptions: - Description: Configuration options for default tooltip display. - Related: DefaultThrowOptions InWorldShopHelpers: - Description: Utility functions for managing in-world shops. LEADEBOARD_SCORE_MAX_VALUE: - Description: The maximum allowable score value for leaderboards. - Type: Number PVAR_CHARACTER_LIMIT: - Description: The maximum character limit for player variables. - Type: Number PropTypes: - Description: Defines standard property types used across the API. VoipSettingValues: - Description: Enumerated values for Voice over IP (VoIP) settings. ``` -------------------------------- ### Analytics Type Aliases and Variables Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/analytics_roundstartpayload References type aliases and variables used in analytics, such as round start payload. ```APIDOC Type Aliases (Analytics): Description: Aliases for various types used in analytics. Related: analytics_roundstartpayload ``` ```APIDOC Variables (Analytics): Description: Variables used in analytics reporting. Related: analytics_roundstartpayload ``` ```APIDOC Classes (Analytics): Description: Classes related to analytics data structures. Related: analytics_roundstartpayload ``` ```APIDOC Enumerations (Analytics): Description: Enumerations used within analytics. Related: analytics_roundstartpayload ``` ```APIDOC Abstract Classes (Analytics): Description: Abstract classes for analytics. Related: analytics_roundstartpayload ``` ```APIDOC core (Analytics): Description: Core analytics functionalities. Related: analytics_roundstartpayload ``` -------------------------------- ### Capturing API Reference Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/analytics_participationenum Handles video capturing functionalities, including start, stop, and camera movement presets. ```APIDOC PlayerCapturing: Description: Manages player capturing functionalities. VideoCaptureNotifications: Description: Notifications related to video capture. VideoCaptureResponseCode: Description: Response codes for video capture operations. CameraMovementPreset: Description: Defines camera movement presets. FirstPersonMovementCameraMovementPreset: Description: Preset for first-person movement camera. FixedPositionTrackingPlayerCameraMovementPreset: Description: Preset for fixed position tracking camera. StartVideoCaptureOptions: Description: Options for starting video capture. Properties: fileName: str - The name of the video file. duration: float - The duration of the video capture. cameraPreset: CameraMovementPreset - The camera movement preset to use. StopVideoCaptureOptions: Description: Options for stopping video capture. ThirdPersonOverShoulderCameraMovementPreset: Description: Preset for third-person over-the-shoulder camera. DefaultStartVideoCaptureOptions: Description: Default options for starting video capture. DefaultStopVideoCaptureOptions: Description: Default options for stopping video capture. ``` -------------------------------- ### Meta Horizon Worlds Core API - Gizmos and Components Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_attachableplayeranchor Documentation for core components and gizmos in Meta Horizon Worlds, including base classes, AI agents, achievements, assets, audio, and avatar poses. ```APIDOC AttachablePlayerAnchor: Description: Represents an anchor point for attaching entities to a player. CoreAttachablePlayerAnchor: Description: Core implementation of AttachablePlayerAnchor. BaseTestComponent: Description: Base class for test components. Component: Description: Represents a component in the game world. AIAgentGizmo: Description: Gizmo for managing AI agents. AchievementsGizmo: Description: Gizmo for managing achievements. AnimatedEntity: Description: Represents an entity with animations. Asset: Description: Represents an asset in the game. AssetContentData: Description: Data associated with asset content. AssetPoolGizmo: Description: Gizmo for managing asset pools. AttachableEntity: Description: Represents an entity that can be attached to another. AudioGizmo: Description: Gizmo for managing audio. AvatarPoseGizmo: Description: Gizmo for managing avatar poses. Bounds: Description: Represents the bounding volume of an object. CodeBlockEvent: Description: Event related to code blocks. Color: Description: Represents an RGB color value. ``` -------------------------------- ### Meta Horizon Worlds Core Components Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_comparable Documentation for core components in Meta Horizon Worlds, including abstract classes, base components, and various gizmos for entities. ```APIDOC Abstract Classes: BaseTestComponent: Base class for test components. Component: Base class for all components. Classes: AIAgentGizmo: Gizmo for AI agents. AchievementsGizmo: Gizmo for managing achievements. AnimatedEntity: Represents an animated entity. Asset: Represents an asset. AssetContentData: Data associated with asset content. AssetPoolGizmo: Gizmo for managing asset pools. AttachableEntity: Represents an entity that can be attached. AudioGizmo: Gizmo for audio functionalities. AvatarPoseGizmo: Gizmo for avatar poses. Bounds: Represents bounding volumes. CodeBlockEvent: Event related to code blocks. Color: Represents color values. DynamicLightGizmo: Gizmo for dynamic lighting. ``` -------------------------------- ### Quaternion Methods Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_quaternion Provides methods to get the angle and axis of rotation, clone, conjugate, copy, and compare quaternions. ```APIDOC Quaternion: angle(): number Gets the angle, in radians, of rotation represented by the quaternion. Returns: number The angle in radians. axis(): Vec3 Gets the axis of the rotation represented by the quaternion. Returns: Vec3 The vector that represents the axis. clone(): Quaternion Creates a copy of the quaternion. Returns: Quaternion The new quaternion. conjugate(quat: Quaternion, outQuat?: Quaternion): Quaternion Creates a quaternion that is the conjugation of a quaternion. Parameters: quat: Quaternion The quaternion to conjugate. outQuat: Quaternion (Optional) The quaternion to perform the operation on. If this isn't supplied, a new quaternion is created and returned. Returns: Quaternion The new quaternion. conjugateInPlace(): this Updates the current quaternion with its conjugated values. Returns: this The updated quaternion. copy(quat: Quaternion): this Updates the values of the quaternion with the values of another quaternion. Parameters: quat: Quaternion The quaternion to copy. Returns: this The updated quaternion. equals(quatA: Quaternion, quatB: Quaternion): boolean Determines whether two quaternions are equal. A quaternion is equal to another quaternion if its components are equal or if the negation of its components are equal. Parameters: quatA: Quaternion The first quaternion to compare. quatB: Quaternion The second quaternion to compare. Returns: boolean true if the quaternions are equal; otherwise, false. equalsApprox(quatA: Quaternion, quatB: Quaternion, epsilon?: number): boolean Compares the approximate equality between two quaternions. A quaternion is equal to another quaternion if its components are equal or if the negation of its components are equal. Parameters: quatA: Quaternion The first quaternion to compare. quatB: Quaternion The second quaternion to compare. epsilon: number (Optional) The maximum difference in values to consider approximately equal. Returns: boolean true if the quaternions are approximately equal; otherwise, false. ``` -------------------------------- ### Core Options and Configurations Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/ui_animatedbinding Configuration options for various core features, including aim assist, audio, raycasting, and entity interactions. ```APIDOC AimAssistOptions: Options for aim assist. AudioOptions: Configuration options for audio. BaseRaycastHit: Base information for a raycast hit. ``` -------------------------------- ### Bounds Calculation Source: https://developers.meta.com/horizon-worlds/reference/2.0.0/core_entity Methods to get axis-aligned bounding boxes for colliders and renderers within an entity and its children. ```typescript getPhysicsBounds(): Bounds; getRenderBounds(): Bounds; ```