connected-spaces-platform.web 6.1.0 → 6.2.0

package/connectedspacesplatform.d.ts

@@ -507,7 +507,10 @@ export declare namespace Multiplayer {
         ThirdPartyComponentRef = 12,
         IsShadowCaster = 13,
         MaterialOverrides = 14,
-        Num = 15
+        IsVirtualVisible = 15,
+        ShowAsHoldoutInAR = 16,
+        ShowAsHoldoutInVirtual = 17,
+        Num = 18
     }
 }
 export declare namespace Multiplayer {
@@ -582,7 +585,8 @@ export declare namespace Multiplayer {
         LocomotionModel = 14,
         IsVisible = 15,
         IsARVisible = 16,
-        Num = 17
+        IsVirtualVisible = 17,
+        Num = 18
     }
 }
 export declare namespace Multiplayer {
@@ -607,7 +611,8 @@ export declare namespace Multiplayer {
         IsVisible = 7,
         IsEnabled = 8,
         IsARVisible = 9,
-        Num = 10
+        IsVirtualVisible = 10,
+        Num = 11
     }
 }
 export declare namespace Multiplayer {
@@ -729,7 +734,8 @@ export declare namespace Multiplayer {
         IsEnabled = 6,
         IsVisible = 7,
         IsARVisible = 8,
-        Num = 9
+        IsVirtualVisible = 9,
+        Num = 10
     }
 }
 export declare namespace Multiplayer {
@@ -745,7 +751,8 @@ export declare namespace Multiplayer {
         Scale = 5,
         IsVisible = 6,
         IsARVisible = 7,
-        Num = 8
+        IsVirtualVisible = 8,
+        Num = 9
     }
 }
 export declare namespace Multiplayer {
@@ -767,7 +774,8 @@ export declare namespace Multiplayer {
         IsVisible = 11,
         IsARVisible = 12,
         ThirdPartyComponentRef = 13,
-        Num = 14
+        IsVirtualVisible = 14,
+        Num = 15
     }
 }
 export declare namespace Multiplayer {
@@ -795,7 +803,8 @@ export declare namespace Multiplayer {
         IsARVisible = 7,
         IsShadowCaster = 8,
         Tint = 9,
-        Num = 10
+        IsVirtualVisible = 10,
+        Num = 11
     }
 }
 export declare namespace Multiplayer {
@@ -810,7 +819,8 @@ export declare namespace Multiplayer {
         IsSpawnPoint = 4,
         IsVisible = 5,
         IsARVisible = 6,
-        Num = 7
+        IsVirtualVisible = 7,
+        Num = 8
     }
 }
 export declare namespace Multiplayer {
@@ -829,7 +839,8 @@ export declare namespace Multiplayer {
         DisplayMode = 8,
         IsARVisible = 9,
         IsEmissive = 10,
-        Num = 11
+        IsVirtualVisible = 11,
+        Num = 12
     }
 }
 export declare namespace Multiplayer {
@@ -895,7 +906,8 @@ export declare namespace Multiplayer {
         IsARVisible = 13,
         ThirdPartyComponentRef = 14,
         LightShadowType = 15,
-        Num = 16
+        IsVirtualVisible = 16,
+        Num = 17
     }
 }
 export declare namespace Multiplayer {
@@ -954,7 +966,8 @@ export declare namespace Multiplayer {
         DefaultImageCollectionId = 7,
         DefaultImageAssetId = 8,
         AttenuationRadius = 9,
-        Num = 10
+        IsVirtualVisible = 10,
+        Num = 11
     }
 }
 export declare namespace Multiplayer {
@@ -1003,7 +1016,10 @@ export declare namespace Multiplayer {
         ThirdPartyComponentRef = 8,
         IsShadowCaster = 9,
         MaterialOverrides = 10,
-        Num = 11
+        IsVirtualVisible = 11,
+        ShowAsHoldoutInAR = 12,
+        ShowAsHoldoutInVirtual = 13,
+        Num = 14
     }
 }
 export declare namespace Multiplayer {
@@ -1023,7 +1039,8 @@ export declare namespace Multiplayer {
         BillboardMode = 9,
         IsVisible = 10,
         IsARVisible = 11,
-        Num = 12
+        IsVirtualVisible = 12,
+        Num = 13
     }
 }
 export declare namespace Multiplayer {
@@ -1083,7 +1100,8 @@ export declare namespace Multiplayer {
         IsARVisible = 17,
         MeshComponentId = 18,
         IsEnabled = 19,
-        Num = 20
+        IsVirtualVisible = 20,
+        Num = 21
     }
 }
 export declare namespace Multiplayer {
@@ -1378,6 +1396,40 @@ export declare namespace Multiplayer {
         setPosition: (value: Common.Vector3) => void;
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Controls rendering behavior properties, such as a holdout state related to display modes, for a component.
+     */
+    interface IRenderBehaviourComponent {
+        /**
+        @defgroup HoldoutConcept Holdouts and Data Access
+         * A holdout is an object that is rendered as a mask, cutting it out from the final image.
+         * It still participates in depth testing, allowing objects to move behind it, but does not contribute pixels to the final image.
+         * @description Checks if the component is shown as holdout when in AR mode.
+         * @return True if the component is shown as holdout when in AR mode, false otherwise.
+         * /// @see HoldoutConcept
+         */
+        getShowAsHoldoutInAR: () => boolean;
+        /**
+         * @description Sets if the component is shown as holdout in AR mode.
+         * @param inValue - True if the component is shown as holdout in AR mode, false otherwise.
+         * /// @see HoldoutConcept
+         */
+        setShowAsHoldoutInAR: (value: boolean) => void;
+        /**
+         * @description Checks if the component is shown as holdout when in Virtual mode.
+         * @return True if the component is shown as holdout when in Virtual mode, false otherwise.
+         * /// @see HoldoutConcept
+         */
+        getShowAsHoldoutInVirtual: () => boolean;
+        /**
+         * @description Sets if the component is shown as holdout in Virtual mode.
+         * @param inValue - True if the component is shown as holdout in Virtual mode, false otherwise.
+         * /// @see HoldoutConcept
+         */
+        setShowAsHoldoutInVirtual: (value: boolean) => void;
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Controls the 3D rotation of the component.
@@ -1494,7 +1546,7 @@ export declare namespace Multiplayer {
 }
 export declare namespace Multiplayer {
     /**
-     * @description Controls the visibility of the component when in default mode or in AR mode.
+     * @description Controls the visibility of the component when in default mode, AR mode or Virtual mode.
      */
     interface IVisibleComponent {
         /**
@@ -1517,6 +1569,16 @@ export declare namespace Multiplayer {
          * @param inValue - True if the component is visible in AR mode, false otherwise.
          */
         setIsARVisible: (value: boolean) => void;
+        /**
+         * @description Checks if the component is visible when in Virtual mode.
+         * @return True if the component is visible when in Virtual mode, false otherwise.
+         */
+        getIsVirtualVisible: () => boolean;
+        /**
+         * @description Sets if the component is visible in Virtual mode.
+         * @param inValue - True if the component is visible in Virtual mode, false otherwise.
+         */
+        setIsVirtualVisible: (value: boolean) => void;
     }
 }
 export declare namespace Systems {
@@ -4911,11 +4973,6 @@ export declare namespace Systems {
          * @return Pointer to the graphql system class
          */
         getGraphQLSystem(): Systems.GraphQLSystem;
-        /**
-         * @description Retrieves the Analytics system.
-         * @return Pointer to the analytics system class
-         */
-        getAnalyticsSystem(): Systems.AnalyticsSystem;
         /**
          * @description Retrieves the Maintenance system.
          * @return Pointer to the maintenance system class
@@ -4997,57 +5054,6 @@ export declare namespace Systems {
         getFailureReason(): Systems.ERequestFailureReason;
     }
 }
-export declare namespace Systems {
-    /**
-  @ingroup Analytics System
-   * @description Interface for an Analytics Provider
-   */
-    class IAnalyticsProvider extends NativeClassWrapper implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        delete(): void;
-    }
-}
-export declare namespace Systems {
-    /**
-  @ingroup Analytics System
-   * @description Public facing system that allows interfacing with an analytics provider.
-   * Offers methods for sending events to the provider
-   * Events are added to a queue to be processewd on a different thread
-   * If events are unable to be send to the provider, then they will be held in the queue
-   */
-    class AnalyticsSystem extends NativeClassWrapper {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        /**
-         * @description Send an event
-         * @param event - AnalyticsEvent
-         */
-        log(event: Systems.AnalyticsEvent): void;
-    }
-}
-export declare namespace Systems {
-    class AnalyticsEvent extends NativeClassWrapper implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        addInt(key: string, value: bigint): void;
-        addString(key: string, value: string): void;
-        addFloat(key: string, value: number): void;
-        addBool(key: string, value: boolean): void;
-        getInt(key: string): bigint;
-        getString(key: string): string;
-        getFloat(key: string): number;
-        getBool(key: string): boolean;
-        getTag(): string;
-        delete(): void;
-    }
-}
-export declare namespace Systems {
-    class AnalyticsEventInitialiser {
-        static initialise(tag: string): Systems.AnalyticsEvent;
-        static deInitialise(event: Systems.AnalyticsEvent): void;
-    }
-}
 export declare namespace Systems {
     /**
   @ingroup Asset System
@@ -6484,7 +6490,7 @@ export declare namespace Multiplayer {
    * /// These are used for objects that need to move or act within the space, such as characters or animated props.
    * This component makes it possible to play, pause, or loop animations.
    */
-    class AnimatedModelSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, Multiplayer.IExternalResourceComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.IShadowCasterComponent, INativeResource {
+    class AnimatedModelSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, Multiplayer.IExternalResourceComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.IShadowCasterComponent, Multiplayer.IRenderBehaviourComponent, INativeResource {
         /** @internal */
         constructor(pointer: NativePointer);
         static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.AnimatedModelSpaceComponent;
@@ -6616,6 +6622,14 @@ export declare namespace Multiplayer {
          */
         setIsARVisible(value: boolean): void;
         /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
+        /**
         @}
          * \addtogroup IThirdPartyComponentRef
         @{
@@ -6637,6 +6651,25 @@ export declare namespace Multiplayer {
         @copydoc IShadowCasterComponent::SetIsShadowCaster()
          */
         setIsShadowCaster(value: boolean): void;
+        /**
+        @}
+         * \addtogroup IRenderBehaviourComponent
+        @{
+        @copydoc IRenderBehaviourComponent::GetShowAsHoldoutInAR()
+         */
+        getShowAsHoldoutInAR(): boolean;
+        /**
+        @copydoc IRenderBehaviourComponent::SetShowAsHoldoutInAR()
+         */
+        setShowAsHoldoutInAR(value: boolean): void;
+        /**
+        @copydoc IRenderBehaviourComponent::GetShowAsHoldoutInVirtual()
+         */
+        getShowAsHoldoutInVirtual(): boolean;
+        /**
+        @copydoc IRenderBehaviourComponent::SetShowAsHoldoutInVirtual()
+         */
+        setShowAsHoldoutInVirtual(value: boolean): void;
         delete(): void;
     }
 }
@@ -7021,6 +7054,14 @@ export declare namespace Multiplayer {
         @copydoc IVisibleComponent::SetIsARVisible()
          */
         setIsARVisible(value: boolean): void;
+        /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
         delete(): void;
     }
 }
@@ -7136,6 +7177,14 @@ export declare namespace Multiplayer {
         @copydoc IVisibleComponent::SetIsARVisible()
          */
         setIsARVisible(value: boolean): void;
+        /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
         delete(): void;
     }
 }
@@ -7914,6 +7963,14 @@ export declare namespace Multiplayer {
         @copydoc IVisibleComponent::SetIsARVisible()
          */
         setIsARVisible(value: boolean): void;
+        /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
         delete(): void;
     }
 }
@@ -8022,6 +8079,14 @@ export declare namespace Multiplayer {
         @copydoc IVisibleComponent::SetIsARVisible()
          */
         setIsARVisible(value: boolean): void;
+        /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
         delete(): void;
     }
 }
@@ -8188,6 +8253,14 @@ export declare namespace Multiplayer {
          */
         setIsARVisible(value: boolean): void;
         /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
+        /**
         @}
          * \addtogroup IThirdPartyComponentRef
         @{
@@ -8297,6 +8370,14 @@ export declare namespace Multiplayer {
          */
         setIsARVisible(value: boolean): void;
         /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
+        /**
         @}
          * \addtogroup IShadowCasterComponent
         @{
@@ -8420,6 +8501,14 @@ export declare namespace Multiplayer {
         @copydoc IVisibleComponent::SetIsARVisible()
          */
         setIsARVisible(value: boolean): void;
+        /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
         delete(): void;
     }
 }
@@ -8558,6 +8647,14 @@ export declare namespace Multiplayer {
         @copydoc IVisibleComponent::SetIsARVisible()
          */
         setIsARVisible(value: boolean): void;
+        /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
         delete(): void;
     }
 }
@@ -8717,6 +8814,14 @@ export declare namespace Multiplayer {
          */
         setIsARVisible(value: boolean): void;
         /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
+        /**
         @}
          * \addtogroup IThirdPartyComponentRef
         @{
@@ -9008,6 +9113,14 @@ export declare namespace Multiplayer {
          */
         setIsARVisible(value: boolean): void;
         /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
+        /**
         @}
          * \addtogroup IShadowCasterComponent
         @{
@@ -9109,7 +9222,7 @@ export declare namespace Multiplayer {
    * /// It displays non-animated objects, such as furniture, buildings, or decorative items within a space.
    * The static model defines the visual appearance but has no animations or dynamic behaviors.
    */
-    class StaticModelSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IExternalResourceComponent, Multiplayer.IShadowCasterComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
+    class StaticModelSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IExternalResourceComponent, Multiplayer.IShadowCasterComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, Multiplayer.IRenderBehaviourComponent, INativeResource {
         /** @internal */
         constructor(pointer: NativePointer);
         static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.StaticModelSpaceComponent;
@@ -9211,6 +9324,14 @@ export declare namespace Multiplayer {
          */
         setIsARVisible(value: boolean): void;
         /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
+        /**
         @}
          * \addtogroup IThirdPartyComponentRef
         @{
@@ -9232,6 +9353,25 @@ export declare namespace Multiplayer {
         @copydoc IShadowCasterComponent::SetIsShadowCaster()
          */
         setIsShadowCaster(value: boolean): void;
+        /**
+        @}
+         * \addtogroup IRenderBehaviourComponent
+        @{
+        @copydoc IRenderBehaviourComponent::GetShowAsHoldoutInAR()
+         */
+        getShowAsHoldoutInAR(): boolean;
+        /**
+        @copydoc IRenderBehaviourComponent::SetShowAsHoldoutInAR()
+         */
+        setShowAsHoldoutInAR(value: boolean): void;
+        /**
+        @copydoc IRenderBehaviourComponent::GetShowAsHoldoutInVirtual()
+         */
+        getShowAsHoldoutInVirtual(): boolean;
+        /**
+        @copydoc IRenderBehaviourComponent::SetShowAsHoldoutInVirtual()
+         */
+        setShowAsHoldoutInVirtual(value: boolean): void;
         delete(): void;
     }
 }
@@ -9372,6 +9512,14 @@ export declare namespace Multiplayer {
         @copydoc IVisibleComponent::SetIsARVisible()
          */
         setIsARVisible(value: boolean): void;
+        /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
         delete(): void;
     }
 }
@@ -9585,6 +9733,14 @@ export declare namespace Multiplayer {
          */
         setIsARVisible(value: boolean): void;
         /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
+        /**
         @}
          * \addtogroup IEnableableComponent
         @{