connected-spaces-platform.web 6.1.0 → 6.3.0

package/connectedspacesplatform.d.ts

@@ -422,13 +422,21 @@ export declare namespace Multiplayer {
 }
 export declare namespace Multiplayer {
     /**
-     * @description Enum used to specify the the type of a space entity
-     * /// Note that this specifically starts from 1 as 0 is reserved for internal purposes.
-     * Any additions should not use 0.
+     * @description Enum used to specify what part of a SpaceEntity was updated when deserialising.
+     * Use this to determine which parts of an entity to copy values from when an update occurs.
+     * It is a bitwise flag enum, so values are additive, the value may represent several flags.
      */
-    enum SpaceEntityType {
-        Avatar = 1,
-        Object = 2
+    enum SpaceEntityUpdateFlags {
+        UPDATE_FLAGS_NAME = 1,
+        UPDATE_FLAGS_POSITION = 2,
+        UPDATE_FLAGS_ROTATION = 4,
+        UPDATE_FLAGS_SCALE = 8,
+        UPDATE_FLAGS_COMPONENTS = 16,
+        UPDATE_FLAGS_SELECTION_ID = 32,
+        UPDATE_FLAGS_THIRD_PARTY_REF = 64,
+        UPDATE_FLAGS_THIRD_PARTY_PLATFORM = 128,
+        UPDATE_FLAGS_PARENT = 256,
+        UPDATE_FLAGS_LOCK_TYPE = 512
     }
 }
 export declare namespace Multiplayer {
@@ -449,21 +457,13 @@ export declare namespace Multiplayer {
 }
 export declare namespace Multiplayer {
     /**
-     * @description Enum used to specify what part of a SpaceEntity was updated when deserialising.
-     * Use this to determine which parts of an entity to copy values from when an update occurs.
-     * It is a bitwise flag enum, so values are additive, the value may represent several flags.
+     * @description Enum used to specify the the type of a space entity
+     * /// Note that this specifically starts from 1 as 0 is reserved for internal purposes.
+     * Any additions should not use 0.
      */
-    enum SpaceEntityUpdateFlags {
-        UPDATE_FLAGS_NAME = 1,
-        UPDATE_FLAGS_POSITION = 2,
-        UPDATE_FLAGS_ROTATION = 4,
-        UPDATE_FLAGS_SCALE = 8,
-        UPDATE_FLAGS_COMPONENTS = 16,
-        UPDATE_FLAGS_SELECTION_ID = 32,
-        UPDATE_FLAGS_THIRD_PARTY_REF = 64,
-        UPDATE_FLAGS_THIRD_PARTY_PLATFORM = 128,
-        UPDATE_FLAGS_PARENT = 256,
-        UPDATE_FLAGS_LOCK_TYPE = 512
+    enum SpaceEntityType {
+        Avatar = 1,
+        Object = 2
     }
 }
 export declare namespace Multiplayer {
@@ -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 {
@@ -1614,11 +1676,12 @@ export declare class CSPFoundation {
      * @description Sets the endpoints for the various services needed for foundation, passes over the client header information and initialises the
      * systems required for foundation to operate.
      * @param endpointRootURI - Root URI for service endpoints
-     * @param tenant - Tenant for Magnopus Services. Data is not shared between tenants so clients using separate tenants cannot
-     * interact with each other.
+     * @param tenant - Tenant for Magnopus Services. Data is not shared between tenants so clients using separate tenants
+     * cannot interact with each other.
+     * @param clientUserAgentHeader - The Client Info data
      * @return True for successful initialisation.
      */
-    static initialise(endpointRootURI: string, tenant: string): boolean;
+    static initialise(endpointRootURI: string, tenant: string, clientUserAgentHeader: ClientUserAgent): boolean;
     /**
      * @description This should be used at the end of the application lifecycle.
      * Clears event queues and destroys foundation systems.
@@ -1670,12 +1733,6 @@ export declare class CSPFoundation {
      * @return EndpointURIs class with deduced endpoint URIs.
      */
     static createEndpointsFromRoot(endpointRootURI: string): EndpointURIs;
-    /**
-     * @description Sets a class containing all relevant Client info currently set for Foundation.
-     * Used internally to generate ClientUserAgentString.
-     * @param the - Client Info class with current Client Info data
-     */
-    static setClientUserAgentInfo(clientUserAgentHeader: ClientUserAgent): void;
     /**
      * @description Gets a class containing all relevant Client info currently set for Foundation.
      * @return The Client Info class with current Client Info data
@@ -1689,7 +1746,7 @@ export declare class CSPFoundation {
     static getClientUserAgentString(): string;
     /**
      * @description Gets the tenant that foundation is currently using, based on what was provided during initialisation.
-     * @return Csp::common::string&
+     * @return Const csp::common::string&
      */
     static getTenant(): string;
 }
@@ -3863,21 +3920,12 @@ export declare namespace Common {
          * which will provide a non-owning pointer to the new SpaceEntity so that it can be used on the local client.
          */
         createEntity(name: string, spaceTransform: Multiplayer.SpaceTransform, parentID: bigint | null): Promise<Multiplayer.SpaceEntity>;
-        addEntity(entityToAdd: Multiplayer.SpaceEntity): void;
         /**
          * @description Destroy the specified entity.
          * @param entity - A non-owning pointer to the entity to be destroyed.
          * @param callback - A callback that executes when the entity destruction is complete.
          */
         destroyEntity(entity: Multiplayer.SpaceEntity): Promise<boolean>;
-        /**
-         * @description Sets a callback to be executed when an entity is fully created.
-         * /// Only one EntityCreatedCallback may be registered, calling this function again will override whatever was previously set.
-         * The better way to set this and avoid initialisation race conditions is via passing this in the constructor, only use this if you wish to
-         * override or remove this callback.
-         * /// @param Callback csp::multiplayer::EntityCreatedCallback : the callback to execute.
-         */
-        setEntityCreatedCallback(callback: (arg1: Multiplayer.SpaceEntity) => void): void;
         /**
          * @description Finds the first found SpaceEntity of a matching Name.
          * @param name - The name to search.
@@ -3920,6 +3968,12 @@ export declare namespace Common {
          * @return A non-owning pointer to the object entity with the given index.
          */
         getObjectByIndex(objectIndex: number): Multiplayer.SpaceEntity;
+        /**
+         * @description Return all the entities currently known to the realtime engine.
+        @warning This list may be extremely large.
+         * @return A non-owning pointer to a List of non-owning pointers to all entities.
+         */
+        getAllEntities(): Common.List<Multiplayer.SpaceEntity>;
         /**
          * @description Get the number of total entities in the system.
          * @return The total number of entities.
@@ -3949,16 +4003,6 @@ export declare namespace Common {
          * entity fetch
          */
         setEntityFetchCompleteCallback(callback: (arg1: number) => void): void;
-        /**
-         * @description Adds an entity to a list of entities to be updated when ProcessPendingEntityOperations is called.
-         * From a client perspective, ProcessPendingEntityOperations is normally called via the CSPFoundation::Tick method.
-         * @param entity - A non-owning pointer to the entity to be marked.
-         */
-        markEntityForUpdate(entity: Multiplayer.SpaceEntity): void;
-        /**
-         * @description Applies any pending changes to entities that have been marked for update.
-         */
-        processPendingEntityOperations(): void;
     }
 }
 export declare namespace Common {
@@ -4037,6 +4081,7 @@ export declare namespace Multiplayer {
     class ComponentBase extends NativeClassWrapper implements INativeResource {
         /** @internal */
         constructor(pointer: NativePointer);
+        static create_type_logSystem_parent(type: Multiplayer.ComponentType, logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): ComponentBase;
         /**
          * @description Virtual destructor for the component.
          */
@@ -4107,14 +4152,10 @@ export declare namespace Multiplayer {
         /**
          * @description Constructor for CSPSceneDescription by deserializing a SceneDescription json file.
          * @param sceneDescriptionJson - The SceneDescription to deserialize.
-         * @param entitySystem - The OnlineRealtimeEngine for this session.
-         * @param logSystem - The OnlineRealtimeEngine for this session.
-         * @param remoteScriptRunner - The ScriptRunner for this session.
          */
-        static create_sceneDescriptionJson_entitySystem_logSystem_remoteScriptRunner(sceneDescriptionJson: string, entitySystem: Multiplayer.OnlineRealtimeEngine, logSystem: Common.LogSystem, remoteScriptRunner: Common.IJSScriptRunner): CSPSceneDescription;
+        static create_sceneDescriptionJson(sceneDescriptionJson: string): CSPSceneDescription;
+        static create(): CSPSceneDescription;
         delete(): void;
-        get entities(): Common.Array<Multiplayer.SpaceEntity>;
-        set entities(value: Common.Array<Multiplayer.SpaceEntity>);
     }
 }
 export declare namespace Multiplayer {
@@ -4279,13 +4320,13 @@ export declare namespace Multiplayer {
         /**
          * @description Creates a SpaceEntity instance using the space entity system provided.
          */
-        static create_entitySystem_scriptRunner_logSystem(entitySystem: Multiplayer.OnlineRealtimeEngine, scriptRunner: Common.IJSScriptRunner, logSystem: Common.LogSystem): SpaceEntity;
+        static create_entitySystem_scriptRunner_logSystem(entitySystem: Common.IRealtimeEngine, scriptRunner: Common.IJSScriptRunner, logSystem: Common.LogSystem): SpaceEntity;
         /**
          * @description Destroys the SpaceEntity instance.
          */
         delete(): void;
         /**
-         * @description Get the ID of this SpaceEntity, this is generated by the endpoints and should be unique to each Entity.
+         * @description Get the ID of this SpaceEntity, this should be unique to each Entity.
          * @return The uint64_t ID of the SpaceEntity.
          */
         getId(): bigint;
@@ -4303,8 +4344,9 @@ export declare namespace Multiplayer {
         /**
          * @description Set the name of the SpaceEntity.
          * @param value - The name to set.
+         * @return Whether a new value was set, may fail if not modifiable, or if a dirty property is already set to this value.
          */
-        setName(value: string): void;
+        setName(value: string): boolean;
         /**
          * @description Get the SpaceTransform of the SpaceEntity.
          * @return SpaceTransform.
@@ -4328,8 +4370,9 @@ export declare namespace Multiplayer {
         /**
          * @description Set the position of the SpaceEntity, in world space.
          * @param value - The position to set.
+         * @return Whether a new value was set, may fail if not modifiable, or if a dirty property is already set to this value.
          */
-        setPosition(value: Common.Vector3): void;
+        setPosition(value: Common.Vector3): boolean;
         /**
          * @description Get the rotation of the SpaceEntity.
          * @return Rotation.
@@ -4343,8 +4386,9 @@ export declare namespace Multiplayer {
         /**
          * @description Set the rotation of the SpaceEntity.
          * @param value - The rotation to set.
+         * @return Whether a new value was set, may fail if not modifiable, or if a dirty property is already set to this value.
          */
-        setRotation(value: Common.Vector4): void;
+        setRotation(value: Common.Vector4): boolean;
         /**
          * @description Get the scale of the SpaceEntity.
          * @return Scale.
@@ -4358,8 +4402,9 @@ export declare namespace Multiplayer {
         /**
          * @description Set the scale of the SpaceEntity.
          * @param value - The scale to set.
+         * @return Whether a new value was set, may fail if not modifiable, or if a dirty property is already set to this value.
          */
-        setScale(value: Common.Vector3): void;
+        setScale(value: Common.Vector3): boolean;
         /**
          * @description Get whether the space is transient or persistent.
          * @return Returns true if the space is transient and false if it is marked as persistent.
@@ -4373,8 +4418,9 @@ export declare namespace Multiplayer {
         /**
          * @description Set the third party reference for this entity
          * @param inThirdPartyRef - The third party reference to set.
+         * @return Whether a new value was set, may fail if not modifiable, or if a dirty property is already set to this value.
          */
-        setThirdPartyRef(thirdPartyRef: string): void;
+        setThirdPartyRef(thirdPartyRef: string): boolean;
         /**
          * @description Get the third party platform type of this entity.
          * @return A string representing third party platform type set for this entity.
@@ -4383,8 +4429,9 @@ export declare namespace Multiplayer {
         /**
          * @description Set third party platform type for this entity.
          * @param inThirdPartyPlatformType - The third party platform type to set.
+         * @return Whether a new value was set, may fail if not modifiable, or if a dirty property is already set to this value.
          */
-        setThirdPartyPlatformType(thirdPartyPlatformType: Systems.EThirdPartyPlatform): void;
+        setThirdPartyPlatformType(thirdPartyPlatformType: Systems.EThirdPartyPlatform): boolean;
         /**
          * @description Get the type of the Entity.
          * @return The SpaceEntityType enum value.
@@ -4403,7 +4450,7 @@ export declare namespace Multiplayer {
         removeParentEntity(): void;
         /**
          * @description Gets the parent of this entity
-         * @return SpaceEntity
+         * @return Non-owning pointer to the parent of this entity. May be null.
          */
         getParentEntity(): Multiplayer.SpaceEntity;
         /**
@@ -4419,10 +4466,6 @@ export declare namespace Multiplayer {
          * @return Csp::common::list&lt;spaceentity&gt;
          */
         getChildEntities(): Common.List<Multiplayer.SpaceEntity>;
-        /**
-         * @description Queues an update which will be executed on next Tick() or ProcessPendingEntityOperations(). Not a blocking or async function.
-         */
-        queueUpdate(): void;
         /**
          * @description Sends a patch message with a flag to destroy the entity.
          * /// Will remove the entity from endpoints and signal remote clients to delete the entity.
@@ -4449,6 +4492,11 @@ export declare namespace Multiplayer {
          * @param callback - Contains a bool that is true when the patch message is sent.
          */
         setPatchSentCallback(callback: (arg1: boolean) => void): void;
+        /**
+         * @description Get a pointer to the first component on the entity of specified type
+         * @return Non-owning pointer to component, nullptr if component of type cannot be found
+         */
+        findFirstComponentOfType(type: Multiplayer.ComponentType): Multiplayer.ComponentBase;
         /**
          * @description Get the map of components on this SpaceEntity.
          * @return A map of components indexed with the component ID.
@@ -4472,8 +4520,10 @@ export declare namespace Multiplayer {
          * the best we can do is add a blank component in its place, which clients decide to
          * ignore when retrieving data.
          * /// @param Key uint16_t : The component ID of the component to remove.
+         * @return Whether a component was removed, may fail if not modifiable, there is no component of provided key, or if a dirty component is
+         * already set to this deletion.
          */
-        removeComponent(key: number): void;
+        removeComponent(key: number): boolean;
         /**
          * @description Gets the script associated with the space entity.
          * @return The EntityScript instance set on the entity.
@@ -4514,21 +4564,32 @@ export declare namespace Multiplayer {
          * A CSP error will be sent to the LogSystem if this condition is not met.
         @post This internally sets the lock type as a dirty property.
          * This entity should now be replicated, to process the change.
+         * @return Whether setting the lock was successful.
          */
-        lock(): void;
+        lock(): boolean;
         /**
          * @description Unlocks the entity if the entity is locked
         @pre The entity must be locked.
          * A CSP error will be sent to the LogSystem if this condition is not met.
         @post This internally sets the lock type as a dirty property.
          * This entity should now be replicated, to process the change.
+         * @return Whether removing the lock was successful.
          */
-        unlock(): void;
+        unlock(): boolean;
+        /**
+         * @description Gets the type of lock currently applied to this entity
+         * @return The Locktype, will be LockType::None if the entity is currently unlocked.
+         */
+        getLockType(): Multiplayer.LockType;
         /**
          * @description Checks if the entity has a lock type other than LockType::None, set by calling SpaceEntity::Lock.
          * @return Bool
          */
         isLocked(): boolean;
+        /**
+         * @description Queues an update which will be executed on next Tick() or ProcessPendingEntityOperations(). Not a blocking or async function.
+         */
+        queueUpdate(): void;
     }
 }
 export declare namespace Multiplayer {
@@ -4772,6 +4833,8 @@ export declare namespace Systems {
         set assets(value: Common.Array<Systems.Asset>);
         get sequences(): Common.Array<Systems.Sequence>;
         set sequences(value: Common.Array<Systems.Sequence>);
+        get anchors(): Common.Array<Systems.Anchor>;
+        set anchors(value: Common.Array<Systems.Anchor>);
     }
 }
 export declare namespace Systems {
@@ -4911,11 +4974,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
@@ -4948,7 +5006,6 @@ export declare namespace Systems {
         getHotspotSequenceSystem(): Systems.HotspotSequenceSystem;
         getMultiplayerConnection(): Multiplayer.MultiplayerConnection;
         getEventBus(): Multiplayer.NetworkEventBus;
-        makeOnlineRealtimeEngine(): Multiplayer.OnlineRealtimeEngine;
     }
 }
 export declare namespace Systems {
@@ -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
@@ -6274,6 +6280,144 @@ export declare namespace Common {
         set hotspotData(value: Common.HotspotSequenceChangedNetworkEventData);
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Class for creating and managing objects in an offline context.
+     * /// This provides functionality to create and manage a player avatar and other objects while being offline.
+     * The callbacks that are injected into functions are all synchronous, meaning they are called before the funciton ends.
+     */
+    class OfflineRealtimeEngine extends Common.IRealtimeEngine implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromIRealtimeEngine(baseInstance: Common.IRealtimeEngine): Multiplayer.OfflineRealtimeEngine;
+        /**
+         * @description OfflineRealtimeEngine constructor.
+         * Creates a realtime engine pre-populated from a scene description. (Usually parsed from a checkpoint file)
+         * @param sceneDescription - The scene description containing entities within the scene.
+         * These entities will be populated in the RealtimeEngine.
+         * @param logSystem - Logger such that this system can print status and debug output
+         * @param remoteScriptRunner - Object capable of running a script.
+         */
+        static create_sceneDescription_logSystem_remoteScriptRunner(sceneDescription: Multiplayer.CSPSceneDescription, logSystem: Common.LogSystem, remoteScriptRunner: Common.IJSScriptRunner): OfflineRealtimeEngine;
+        /**
+         * @description OfflineRealtimeEngine constructor
+         * Creates an empty realtime engine.
+         * @param logSystem - Logger such that this system can print status and debug output
+         * @param remoteScriptRunner - Object capable of running a script.
+         */
+        static create_logSystem_remoteScriptRunner(logSystem: Common.LogSystem, remoteScriptRunner: Common.IJSScriptRunner): OfflineRealtimeEngine;
+        /**
+         * @description OfflineRealtimeEngine destructor
+         * Removes entity script bindings and deregisters tick event listeners
+         */
+        delete(): void;
+        /**
+         * @description Returns the concrete type of the instantiation of the abstract IRealtimeEngine.
+         */
+        getRealtimeEngineType(): Common.RealtimeEngineType;
+        /**
+         * @description Create and add a SpaceEntity with type Avatar, and relevant components and default states as specified.
+         * @param name - The entity name of the newly created avatar entity.
+         * @param userId - The Id of the user creating the avatar. This can be fetched from csp::systems::UserSystem::GetLoginState
+         * @param transform - The initial transform to set the SpaceEntity to.
+         * @param state - The initial Avatar State to set.
+         * @param avatarId - The ID to be set on the AvatarSpaceComponent
+         * @param avatarPlayMode - The Initial AvatarPlayMode to set.
+         * @param callback - Csp::multiplayer::entitycreatedcallback a callback that executes when the creation is complete,
+         * which will provide a non-owning pointer to the new SpaceEntity so that it can be used on the local client.
+         */
+        createAvatar(name: string, userId: string, transform: Multiplayer.SpaceTransform, isVisible: boolean, state: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode): Promise<Multiplayer.SpaceEntity>;
+        /**
+         * @description Create and add a SpaceEntity, with relevant default values.
+         * @param name - The name of the newly created SpaceEntity.
+         * @param transform - The initial transform to set the SpaceEntity to.
+         * @param parentID - ID of another entity in the space that this entity should be created as a child to. If empty,
+         * entity is created as a root entity.
+         * @param callback - A callback that executes when the creation is complete,
+         * which will provide a non-owning pointer to the new SpaceEntity so that it can be used on the local client.
+         */
+        createEntity(name: string, transform: Multiplayer.SpaceTransform, parentID: bigint | null): Promise<Multiplayer.SpaceEntity>;
+        /**
+         * @description Destroy the specified entity.
+         * @param entity - A non-owning pointer to the entity to be destroyed.
+         * @param callback - A callback that executes when the entity destruction is complete.
+         */
+        destroyEntity(entity: Multiplayer.SpaceEntity): Promise<boolean>;
+        /**
+         * @description Finds the first found SpaceEntity of a matching Name.
+         * @param name - The name to search.
+         * @return A non-owning pointer to the first found matching SpaceEntity.
+         */
+        findSpaceEntity(name: string): Multiplayer.SpaceEntity;
+        /**
+         * @description Finds the first found SpaceEntity that has the ID EntityId.
+         * @param entityId - The Id to look for.
+         * @return A non-owning pointer to the first found matching SpaceEntity.
+         */
+        findSpaceEntityById(entityId: bigint): Multiplayer.SpaceEntity;
+        /**
+         * @description Finds the first found SpaceEntity of a matching Name. The found SpaceEntity will contain an AvatarSpaceComponent.
+         * @param name - The name to search for.
+         * @return A pointer to the first found matching SpaceEntity.
+         */
+        findSpaceAvatar(name: string): Multiplayer.SpaceEntity;
+        /**
+         * @description Finds the first found SpaceEntity of a matching Name. The found SpaceEntity will not contain an AvatarSpaceComponent.
+         * @param name - The name to search for.
+         * @return A pointer to the first found matching SpaceEntity.
+         */
+        findSpaceObject(name: string): Multiplayer.SpaceEntity;
+        /**
+         * @description Get an Entity by its index.
+         * /// @param EntityIndex size_t : The index of the entity to get.
+         * @return A non-owning pointer to the entity at the given index.
+         */
+        getEntityByIndex(entityIndex: number): Multiplayer.SpaceEntity;
+        /**
+         * @description Get an Avatar by its index. The returned pointer will be an entity that contains an AvatarSpaceComponent.
+         * /// @param AvatarIndex size_t : The index of the avatar entity to get.
+         * @return A non-owning pointer to the avatar entity with the given index.
+         */
+        getAvatarByIndex(avatarIndex: number): Multiplayer.SpaceEntity;
+        /**
+         * @description Get an Object by its index. The returned pointer will be an entity that does not contain an AvatarSpaceComponent.
+         * /// @param ObjectIndex size_t : The index of the object entity to get.
+         * @return A non-owning pointer to the object entity with the given index.
+         */
+        getObjectByIndex(objectIndex: number): Multiplayer.SpaceEntity;
+        /**
+         * @description Get the number of total entities in the system.
+         * @return The total number of entities.
+         */
+        getNumEntities(): number;
+        /**
+         * @description Get the number of total Avatars in the system. Avatars are entities that contain AvatarSpaceComponents.
+         * @return The total number of Avatar entities.
+         */
+        getNumAvatars(): number;
+        /**
+         * @description Get the number of total Objects in the system. Objects are entities that do not contain AvatarSpaceComponents.
+         * @return The total number of object entities.
+         */
+        getNumObjects(): number;
+        /**
+         * @description Return all the entities currently known to the realtime engine.
+        @warning This list may be extremely large.
+         * @return A non-owning pointer to a List of non-owning pointers to all entities.
+         */
+        getAllEntities(): Common.List<Multiplayer.SpaceEntity>;
+        /**
+         * @description Retrieves all entities that exist at the root level (do not have a parent entity).
+         * @return A list of root entities containing non-owning pointers to entities.
+         */
+        getRootHierarchyEntities(): Common.List<Multiplayer.SpaceEntity>;
+        /**
+         * @description The client ID of the local client. An arbitrary unchanging value.
+         * @return INT53_MAX, the maximum number expressible in all our interop languages (you can thank javascript for the weird sizing).
+         */
+        static localClientId(): bigint;
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Class for creating and managing multiplayer objects known as space entities.
@@ -6321,26 +6465,12 @@ export declare namespace Multiplayer {
          * which will provide a non-owning pointer to the new SpaceEntity so that it can be used on the local client.
          */
         createEntity(name: string, spaceTransform: Multiplayer.SpaceTransform, parentID: bigint | null): Promise<Multiplayer.SpaceEntity>;
-        /**
-         * @description Add a new entity to the system.
-         * /// This can be called at any time from any thread and internally add the entity to a pending
-         * list which is then updated in a thread safe manner when ProcessPendingEntityOperations
-         * is called from the main thread.
-         * /// @param EntityToAdd SpaceEntity : Pointer to the entity to be added.
-         */
-        addEntity(entityToAdd: Multiplayer.SpaceEntity): void;
         /**
          * @description Destroy the specified entity.
          * @param entity - A non-owning pointer to the entity to be destroyed.
          * @param callback - A callback that executes when the entity destruction is complete.
          */
         destroyEntity(entity: Multiplayer.SpaceEntity): Promise<boolean>;
-        /**
-         * @description Sets a callback to be executed when an entity is fully created.
-         * /// Only one EntityCreatedCallback may be registered, calling this function again will override whatever was previously set.
-         * /// @param Callback csp::multiplayer::EntityCreatedCallback : the callback to execute.
-         */
-        setEntityCreatedCallback(callback: (arg1: Multiplayer.SpaceEntity) => void): void;
         /**
          * @description Finds the first found SpaceEntity of a matching Name.
          * @param name - The name to search.
@@ -6398,6 +6528,12 @@ export declare namespace Multiplayer {
          * @return The total number of object entities.
          */
         getNumObjects(): number;
+        /**
+         * @description Return all the entities currently known to the realtime engine.
+        @warning This list may be extremely large.
+         * @return A non-owning pointer to a List of non-owning pointers to all entities.
+         */
+        getAllEntities(): Common.List<Multiplayer.SpaceEntity>;
         /**
          * @description Retrieves all entities that exist at the root level (do not have a parent entity).
          * @return A list of root entities containing non-owning pointers to entities.
@@ -6408,11 +6544,18 @@ export declare namespace Multiplayer {
          * From a client perspective, ProcessPendingEntityOperations is normally called via the CSPFoundation::Tick method.
          * @param entity - A non-owning pointer to the entity to be marked.
          */
-        markEntityForUpdate(entity: Multiplayer.SpaceEntity): void;
+        queueEntityUpdate(entity: Multiplayer.SpaceEntity): void;
         /**
          * @description Applies any pending changes to entities that have been marked for update.
          */
         processPendingEntityOperations(): void;
+        /**
+         * @description Sets a callback to be executed when a remote entity is created.
+         * To wait for local entities to be created, await the callback provided in the CreateObject/CreateAvatar methods.
+         * /// Only one EntityCreatedCallback may be registered, calling this function again will override whatever was previously set.
+         * /// @param Callback csp::multiplayer::EntityCreatedCallback : the callback to execute.
+         */
+        setRemoteEntityCreatedCallback(callback: (arg1: Multiplayer.SpaceEntity) => void): void;
         /**
          * @description Sets a callback to be executed when the script system is ready to run scripts.
          * @param callback - The callback to execute.
@@ -6457,23 +6600,6 @@ export declare namespace Multiplayer {
          * \endrst
          */
         setEntityPatchRateLimitEnabled(enabled: boolean): void;
-        /**
-         * @description Locks the entity mutex.
-         */
-        lockEntityUpdate(): void;
-        /**
-         * @description Unlocks the entity mutex.
-         */
-        unlockEntityUpdate(): void;
-        /**
-         * @description Queues a specific entity to update. Used in SpaceEntity to queue updates via passing the this pointer
-         */
-        queueEntityUpdate(entityToUpdate: Multiplayer.SpaceEntity): void;
-        /**
-         * @description "Resolves" the entity heirarchy, such that the entity is parented appropriately, and internal buffers are populated appropriately.
-         * (Vague, need more understanding about what this does)
-         */
-        resolveEntityHierarchy(entity: Multiplayer.SpaceEntity): void;
         delete(): void;
     }
 }
@@ -6484,7 +6610,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 +6742,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 +6771,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 +7174,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 +7297,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 +8083,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 +8199,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 +8373,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 +8490,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 +8621,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 +8767,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 +8934,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 +9233,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 +9342,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 +9444,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 +9473,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 +9632,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 +9853,14 @@ export declare namespace Multiplayer {
          */
         setIsARVisible(value: boolean): void;
         /**
+        @copydoc IVisibleComponent::GetIsVirtualVisible()
+         */
+        getIsVirtualVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVirtualVisible()
+         */
+        setIsVirtualVisible(value: boolean): void;
+        /**
         @}
          * \addtogroup IEnableableComponent
         @{
@@ -10305,11 +10581,22 @@ export declare namespace Systems {
         getMaterials(spaceId: string): Promise<Systems.MaterialsResult>;
         /**
          * @description Gets a material using its AssetCollection and Asset Id.
+        @details This is slower than GetMaterialFromUri, as it needs to first retrieve the internal AssetCollection and Asset.
          * @param assetCollectionId - The asset collection id this material is associated with.
          * @param assetId - The asset id this material is associated with.
          * @param callback - Callback when asynchronous task finishes.
          */
         getMaterial(assetCollectionId: string, assetId: string): Promise<Systems.MaterialResult>;
+        /**
+         * @description Gets a material using it's Uri.
+        @details This function does not retrieve the AssetCollection or Asset remotely. It downloads the material directly from the uri.
+         * This should be used in an offline context where The AssetCollection and Asset has been parsed from a SceneData file.
+         * @param assetCollection - The asset collection this material is associated with.
+         * @param assetId - The asset id this material is associated with.
+         * @param uri - The uri this material was uploaded to.
+         * @param callback - Callback when asynchronous task finishes.
+         */
+        getMaterialFromUri(assetCollection: Systems.AssetCollection, assetId: string, uri: string): Promise<Systems.MaterialResult>;
         /**
          * @description Sets a callback for an asset changed event. Triggered when assets, such as textures or meshes, are modified
          * @param callback - Callback to receive data for the asset that has been changed.
@@ -11809,7 +12096,8 @@ export declare namespace Systems {
          * The initial load behaviour will differ based on the concrete IRealtimeEngine passed to this function.
          * If user does not have permission to discover or enter the space, callback will be called with EResultCode::Failed and
          * ERequestFailureReason::UserSpaceAccessDenied
-         * @param spaceId - Space id to enter into
+         * @param spaceId - ID of space to enter into. In the case where you are using an offline realtime engine, this will be the
+         * ID of the local space.
          * @param realtimeEngine - RealtimeEngine to load the space with. This object belongs to the caller, and does not
          * transfer ownership. Once the space is loaded, the caller should be sure to maintain the lifetime of the RealtimeEngine so long
          * as the space is active. Once the caller has called csp::systems::SpaceSystem::ExitSpace and received the callback, then they are
@@ -12435,27 +12723,36 @@ export declare namespace Systems {
          * @param userName - Csp::common::string
          * @param email - Csp::common::string
          * @param password - Csp::common::string
+         * @param createMultiplayerConnection - Whether to create a multiplayer connection. If false, this session will not establish a SignalR
+         * connection to backend services, and thus be unable to receive messages or events. This session will also be unable to enter online spaces via
+         * a csp::multiplayer::OnlineRealtimeEngine. If true, this session will receive events, and may enter both online and offline spaces.
          * @param userHasVerifiedAge - An optional bool to specify whether or not the user has verified that they are over 18
          * @param callback - Callback to call when a response is received
         @pre One of either UserName or Email must not be empty.
         @pre Password must not be empty.
          */
-        login(userName: string, email: string, password: string, userHasVerifiedAge: boolean | null): Promise<Systems.LoginStateResult>;
+        login(userName: string, email: string, password: string, createMultiplayerConnection: boolean, userHasVerifiedAge: boolean | null): Promise<Systems.LoginStateResult>;
         /**
          * @description Resume a previous session for the associated user ID using a refresh token
          * The refresh token can be obtained after registering a callback with `SetNewLoginTokenReceivedCallback` and logging in regularly.
          * @param userId - User ID for the previous session
          * @param refreshToken - Refresh token to be used for refreshing the authentication token
+         * @param createMultiplayerConnection - Whether to create a multiplayer connection. If false, this session will not establish a SignalR
+         * connection to backend services, and thus be unable to receive messages or events. This session will also be unable to enter online spaces via
+         * a csp::multiplayer::OnlineRealtimeEngine. If true, this session will receive events, and may enter both online and offline spaces.
          * @param callback - Callback when asynchronous task finishes
         @pre UserId must not be empty.
          */
-        loginWithRefreshToken(userId: string, refreshToken: string): Promise<Systems.LoginStateResult>;
+        loginWithRefreshToken(userId: string, refreshToken: string, createMultiplayerConnection: boolean): Promise<Systems.LoginStateResult>;
         /**
          * @description Log in to Magnopus Connected Services as a guest.
+         * @param createMultiplayerConnection - Whether to create a multiplayer connection. If false, this session will not establish a SignalR
+         * connection to backend services, and thus be unable to receive messages or events. This session will also be unable to enter online spaces via
+         * a csp::multiplayer::OnlineRealtimeEngine. If true, this session will receive events, and may enter both online and offline spaces.
          * @param userHasVerifiedAge - An optional bool to specify whether or not the user has verified that they are over 18
          * @param callback - Callback to call when a response is received
          */
-        loginAsGuest(userHasVerifiedAge: boolean | null): Promise<Systems.LoginStateResult>;
+        loginAsGuest(createMultiplayerConnection: boolean, userHasVerifiedAge: boolean | null): Promise<Systems.LoginStateResult>;
         /**
         @ingroup Third Party Authentication
          * @description As a Connected Spaces Platform user the 3rd party authentication flow consists of two steps, first calling
@@ -12480,10 +12777,13 @@ export declare namespace Systems {
          * Note: The Authentication Provider and the Redirect URL you've passed in the first step will be used now
          * @param thirdPartyToken - The authentication token returned by the Provider
          * @param thirdPartyStateId - The state Id returned by the Provider
+         * @param createMultiplayerConnection - Whether to create a multiplayer connection. If false, this session will not establish a SignalR
+         * connection to backend services, and thus be unable to receive messages or events. This session will also be unable to enter online spaces via
+         * a csp::multiplayer::OnlineRealtimeEngine. If true, this session will receive events, and may enter both online and offline spaces.
          * @param userHasVerifiedAge - An optional bool to specify whether or not the user has verified that they are over 18
          * @param callback - Callback that contains the result of the magnopus connected services authentication operation
          */
-        loginToThirdPartyAuthenticationProvider(thirdPartyToken: string, thirdPartyStateId: string, userHasVerifiedAge: boolean | null): Promise<Systems.LoginStateResult>;
+        loginToThirdPartyAuthenticationProvider(thirdPartyToken: string, thirdPartyStateId: string, createMultiplayerConnection: boolean, userHasVerifiedAge: boolean | null): Promise<Systems.LoginStateResult>;
         /**
          * @description Logout from Magnopus Connected Services.
          * @param callback - Callback to call when a response is received
@@ -12624,12 +12924,12 @@ export declare namespace Common {
         static ofcsp_multiplayer_ComponentUpdateInfo(): Array<Multiplayer.ComponentUpdateInfo>;
         static ofcsp_common_ReplicatedValue(): Array<Common.ReplicatedValue>;
         static ofcsp_systems_SpaceUserRole(): Array<Systems.SpaceUserRole>;
-        static ofcsp_multiplayer_SpaceEntity(): Array<Multiplayer.SpaceEntity>;
         static ofcsp_multiplayer_NetworkEventRegistration(): Array<Multiplayer.NetworkEventRegistration>;
         static ofcsp_multiplayer_MessageInfo(): Array<Multiplayer.MessageInfo>;
         static ofcsp_systems_AssetCollection(): Array<Systems.AssetCollection>;
         static ofcsp_systems_Asset(): Array<Systems.Asset>;
         static ofcsp_systems_Sequence(): Array<Systems.Sequence>;
+        static ofcsp_systems_Anchor(): Array<Systems.Anchor>;
         static ofcsp_systems_VersionMetadata(): Array<Systems.VersionMetadata>;
         static ofcsp_systems_ServiceStatus(): Array<Systems.ServiceStatus>;
         static ofString(): Array<string>;
@@ -12656,7 +12956,6 @@ export declare namespace Common {
         static ofcsp_systems_BasicSpace(): Array<Systems.BasicSpace>;
         static ofcsp_systems_InviteUserRoleInfo(): Array<Systems.InviteUserRoleInfo>;
         static ofcsp_systems_UserRoleInfo(): Array<Systems.UserRoleInfo>;
-        static ofcsp_systems_Anchor(): Array<Systems.Anchor>;
         static ofcsp_systems_AnchorResolution(): Array<Systems.AnchorResolution>;
         static ofcsp_systems_PointOfInterest(): Array<Systems.PointOfInterest>;
         static ofcsp_systems_BasicProfile(): Array<Systems.BasicProfile>;
@@ -12669,12 +12968,12 @@ export declare namespace Common {
         static ofcsp_multiplayer_ComponentUpdateInfo_number(size: number): Array<Multiplayer.ComponentUpdateInfo>;
         static ofcsp_common_ReplicatedValue_number(size: number): Array<Common.ReplicatedValue>;
         static ofcsp_systems_SpaceUserRole_number(size: number): Array<Systems.SpaceUserRole>;
-        static ofcsp_multiplayer_SpaceEntity_number(size: number): Array<Multiplayer.SpaceEntity>;
         static ofcsp_multiplayer_NetworkEventRegistration_number(size: number): Array<Multiplayer.NetworkEventRegistration>;
         static ofcsp_multiplayer_MessageInfo_number(size: number): Array<Multiplayer.MessageInfo>;
         static ofcsp_systems_AssetCollection_number(size: number): Array<Systems.AssetCollection>;
         static ofcsp_systems_Asset_number(size: number): Array<Systems.Asset>;
         static ofcsp_systems_Sequence_number(size: number): Array<Systems.Sequence>;
+        static ofcsp_systems_Anchor_number(size: number): Array<Systems.Anchor>;
         static ofcsp_systems_VersionMetadata_number(size: number): Array<Systems.VersionMetadata>;
         static ofcsp_systems_ServiceStatus_number(size: number): Array<Systems.ServiceStatus>;
         static ofString_number(size: number): Array<string>;
@@ -12701,7 +13000,6 @@ export declare namespace Common {
         static ofcsp_systems_BasicSpace_number(size: number): Array<Systems.BasicSpace>;
         static ofcsp_systems_InviteUserRoleInfo_number(size: number): Array<Systems.InviteUserRoleInfo>;
         static ofcsp_systems_UserRoleInfo_number(size: number): Array<Systems.UserRoleInfo>;
-        static ofcsp_systems_Anchor_number(size: number): Array<Systems.Anchor>;
         static ofcsp_systems_AnchorResolution_number(size: number): Array<Systems.AnchorResolution>;
         static ofcsp_systems_PointOfInterest_number(size: number): Array<Systems.PointOfInterest>;
         static ofcsp_systems_BasicProfile_number(size: number): Array<Systems.BasicProfile>;