connected-spaces-platform.web 5.21.0 → 6.0.0

package/connectedspacesplatform.d.ts

@@ -300,8 +300,8 @@ export declare namespace Common {
      * @description Enum of concrete types of RealtimeEngines.
      */
     enum RealtimeEngineType {
-        OnlineMultiUser = 0,
-        OnlineSingleUser = 1
+        Online = 0,
+        Offline = 1
     }
 }
 export declare namespace Common {
@@ -385,7 +385,11 @@ export declare namespace Multiplayer {
         SET_ALLOW_SELF_MESSAGING = 10,
         SET_SCOPES = 11,
         START_LISTENING = 12,
-        STOP_LISTENING = 13
+        STOP_LISTENING = 13,
+        ON_OBJECT_MESSAGE = 14,
+        ON_OBJECT_PATCH = 15,
+        ON_REQUEST_TO_SEND_OBJECT = 16,
+        ON_REQUEST_TO_DISCONNECT = 17
     }
 }
 export declare namespace Multiplayer {
@@ -1514,7 +1518,7 @@ export declare namespace Systems {
     }
 }
 /**
- * @description Represents definition for identifying and versioning an external service endpoint..
+ * @description Represents definition for identifying and versioning an external service endpoint.
  */
 export declare class ServiceDefinition extends NativeClassWrapper implements INativeResource {
     /** @internal */
@@ -3784,24 +3788,24 @@ export declare namespace Common {
     }
 }
 export declare namespace Common {
-    class InvalidInterfaceUseError extends NativeClassWrapper implements INativeResource {
+    class IJSScriptRunner extends NativeClassWrapper implements INativeResource {
         /** @internal */
         constructor(pointer: NativePointer);
-        static create_msg(msg: string): InvalidInterfaceUseError;
+        /**
+         * @description Virtual destructor.
+         */
         delete(): void;
-        get msg(): string;
-        set msg(value: string);
+        runScript(contextId: bigint, scriptText: string): boolean;
     }
 }
 export declare namespace Common {
-    class IJSScriptRunner extends NativeClassWrapper implements INativeResource {
+    class InvalidInterfaceUseError extends NativeClassWrapper implements INativeResource {
         /** @internal */
         constructor(pointer: NativePointer);
-        /**
-         * @description Virtual destructor.
-         */
+        static create_msg(msg: string): InvalidInterfaceUseError;
         delete(): void;
-        runScript(contextId: bigint, scriptText: string): boolean;
+        get msg(): string;
+        set msg(value: string);
     }
 }
 export declare namespace Common {
@@ -3819,22 +3823,28 @@ export declare namespace Common {
         /**
          * @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 - Id of the user creating this avatar. If your backend data store requires authentication, this will
+         * probably be your username or some similar unique identifier.
          * @param spaceTransform - The initial transform to set the SpaceEntity to.
-         * @param state - The initial Avatar State to set.
+         * @param isVisible - Whether the avatar defaults to being visible.
+         * @param avatarState - 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, spaceTransform: Multiplayer.SpaceTransform, state: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode): Promise<Multiplayer.SpaceEntity>;
+        createAvatar(name: string, userId: string, spaceTransform: Multiplayer.SpaceTransform, isVisible: boolean, avatarState: 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 spaceTransform - 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, spaceTransform: Multiplayer.SpaceTransform): Promise<Multiplayer.SpaceEntity>;
+        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.
@@ -3844,6 +3854,8 @@ export declare namespace Common {
         /**
          * @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;
@@ -3910,10 +3922,14 @@ export declare namespace Common {
          */
         getRootHierarchyEntities(): Common.List<Multiplayer.SpaceEntity>;
         /**
-         * @description Sets a callback to be executed when all existing entities have been retrieved after entering a space.
-         * @param callback - A callback that executes when all existing entities have been retrieved.
+         * @description Set Callback that notifies when the OnlineRealtimeEngine is in a valid state
+         * after entering a space, and entity mutation can begin. Users should not mutate entities before receiving this callback.
+         * This callback should be emitted in response to FetchAllEntitiesAndPopulateBuffers completing, either syncronously or asyncronously.
+         * This callback must be set prior to entering a space.
+         * @param fetchCompleteCallback - Callback that notifies when the RealtimeEngine has completed initial
+         * entity fetch
          */
-        setInitialEntitiesRetrievedCallback(callback: (arg1: boolean) => void): void;
+        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.
@@ -4072,11 +4088,11 @@ export declare namespace Multiplayer {
         /**
          * @description Constructor for CSPSceneDescription by deserializing a SceneDescription json file.
          * @param sceneDescriptionJson - The SceneDescription to deserialize.
-         * @param entitySystem - The SpaceEntitySystem for this session.
-         * @param logSystem - The SpaceEntitySystem for this session.
+         * @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.SpaceEntitySystem, logSystem: Common.LogSystem, remoteScriptRunner: Common.IJSScriptRunner): CSPSceneDescription;
+        static create_sceneDescriptionJson_entitySystem_logSystem_remoteScriptRunner(sceneDescriptionJson: string, entitySystem: Multiplayer.OnlineRealtimeEngine, logSystem: Common.LogSystem, remoteScriptRunner: Common.IJSScriptRunner): CSPSceneDescription;
         delete(): void;
         get entities(): Common.Array<Multiplayer.SpaceEntity>;
         set entities(value: Common.Array<Multiplayer.SpaceEntity>);
@@ -4129,6 +4145,12 @@ export declare namespace Multiplayer {
          * @return True if self messaging is allowed, false otherwise.
          */
         getAllowSelfMessagingFlag(): boolean;
+        /**
+         * @description Get the currently set realtime engine.
+         * @return Non-owning pointer to currently set realtime engine. This should be non-null when in a space, and null before entering, or after
+         * exiting a space.
+         */
+        getOnlineRealtimeEngine(): Multiplayer.OnlineRealtimeEngine;
         delete(): void;
     }
 }
@@ -4181,25 +4203,21 @@ export declare namespace Multiplayer {
         sendNetworkEventToClient(eventName: string, args: Common.Array<Common.ReplicatedValue>, targetClientId: bigint): Promise<Multiplayer.ErrorCode>;
         /**
          * @description Register interest in a network event, such that the NetworkEventBus will call the provided callback when it arrives
-         * @param registration - Registration information, containing a ReceiverID and an EventName.
-         * @param callback - Callback to invoke when specified event is received.
-         * @return True if the registration was successful, false otherwise, such as in the case where Registration was not-unique, or the callback was
-         * null.
+         * @param registration - Registration information, containing a ReceiverID and an EventName. Will fail to register if
+         * identical callback registration already registered.
+         * @param callback - Callback to invoke when specified event is received. Will fail to register if null.
          */
-        listenNetworkEvent(registration: Multiplayer.NetworkEventRegistration, callback: (networkEventData: Common.NetworkEventData) => void): boolean;
+        listenNetworkEvent(registration: Multiplayer.NetworkEventRegistration, callback: (networkEventData: Common.NetworkEventData) => void): void;
         /**
          * @description Deregister interest in a network event
          * @param registration - Registration information of already registered event, containing a ReceiverID and an EventName.
-         * @return True if the deregistration was successful, false otherwise, such as in the case where Registration was not found
          */
-        stopListenNetworkEvent(registration: Multiplayer.NetworkEventRegistration): boolean;
+        stopListenNetworkEvent(registration: Multiplayer.NetworkEventRegistration): void;
         /**
          * @description Deregister interest in all network events registered to a particular EventReceiverId
          * @param eventReceiverId - EventReceiverId to deregister.
-         * @return True if the deregistration was successful, false otherwise, such as if no events were found to deregister under the provided
-         * EventReceiverId.
          */
-        stopListenAllNetworkEvents(eventReceiverId: string): boolean;
+        stopListenAllNetworkEvents(eventReceiverId: string): void;
         /**
          * @description Get an array of all interests currently registered to the NetworkEventBus
          * @return Csp::common::array&lt;csp::multiplayer::networkeventregistration&gt; a container of all currently registered registrations.
@@ -4242,7 +4260,7 @@ export declare namespace Multiplayer {
         /**
          * @description Creates a SpaceEntity instance using the space entity system provided.
          */
-        static create_entitySystem_scriptRunner_logSystem(entitySystem: Multiplayer.SpaceEntitySystem, scriptRunner: Common.IJSScriptRunner, logSystem: Common.LogSystem): SpaceEntity;
+        static create_entitySystem_scriptRunner_logSystem(entitySystem: Multiplayer.OnlineRealtimeEngine, scriptRunner: Common.IJSScriptRunner, logSystem: Common.LogSystem): SpaceEntity;
         /**
          * @description Destroys the SpaceEntity instance.
          */
@@ -4353,11 +4371,6 @@ export declare namespace Multiplayer {
          * @return The SpaceEntityType enum value.
          */
         getEntityType(): Multiplayer.SpaceEntityType;
-        /**
-         * @description Get SpaceEntitySystem Object
-         * @return SpaceEntitySystem
-         */
-        getSpaceEntitySystem(): Multiplayer.SpaceEntitySystem;
         /**
          * @description Sets the parent for this entity
          * QueueUpdate() should be called afterwards to enable changes to the parent.
@@ -4499,236 +4512,6 @@ export declare namespace Multiplayer {
         isLocked(): boolean;
     }
 }
-export declare namespace Multiplayer {
-    /**
-     * @description Class for creating and managing multiplayer objects known as space entities.
-     * /// This provides functions to create and manage multiple player avatars and other objects.
-     * It manages things like queueing updated entities and triggering tick events. Callbacks
-     * can be registered for certain events that occur within the entity system so clients can
-     * react appropriately.
-     */
-    class SpaceEntitySystem extends NativeClassWrapper implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        /**
-         * @description Creates a SpaceEntity with type Avatar, and relevant components and default states as specified.
-         * @param inName - The name to give the new SpaceEntity.
-         * @param inSpaceTransform - The initial transform to set the SpaceEntity to.
-         * @param isVisible - The initial visibility of the Avatar.
-         * @param inState - The initial Avatar State to set.
-         * @param inAvatarId - The Initial AvatarID to set.
-         * @param inAvatarPlayMode - The Initial AvatarPlayMode to set.
-         * @param callback - EntityCreatedCallback A callback that executes when the creation is complete,
-         * which contains a pointer to the new SpaceEntity so that it can be used on the local client.
-         */
-        createAvatar(name: string, loginState: Common.LoginState, spaceTransform: Multiplayer.SpaceTransform, isVisible: boolean, state: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode): Promise<Multiplayer.SpaceEntity>;
-        /**
-         * @description Creates a SpaceEntity of type Object, and relevant default values.
-         * @param inName - The name to give the new SpaceEntity.
-         * @param inSpaceTransform - The initial transform to set the SpaceEntity to.
-         * @param callback - A callback that executes when the creation is complete,
-         * which contains a pointer to the new SpaceEntity so that it can be used on the local client.
-         */
-        createObject(name: string, spaceTransform: Multiplayer.SpaceTransform): Promise<Multiplayer.SpaceEntity>;
-        /**
-         * @description Destroys both the remote view and the local view of the specified entity.
-         * @param entity - The entity to be destroyed.
-         * @param callback - The callback to execute.
-         */
-        destroyEntity(entity: Multiplayer.SpaceEntity): Promise<boolean>;
-        /**
-         * @description Destroys the local client's view of the specified entity.
-         * @param entity - The entity to be destroyed locally.
-         */
-        localDestroyEntity(entity: Multiplayer.SpaceEntity): void;
-        /**
-         * @description Finds the first SpaceEntity that matches InName.
-         * @param inName - The name to search.
-         * @return A pointer to the first found match SpaceEntity.
-         */
-        findSpaceEntity(name: string): Multiplayer.SpaceEntity;
-        /**
-         * @description Finds the first SpaceEntity that has the ID EntityId.
-         * @param entityId - The Id to look for.
-         * @return A pointer to the first found match SpaceEntity.
-         */
-        findSpaceEntityById(entityId: bigint): Multiplayer.SpaceEntity;
-        /**
-         * @description Finds the first SpaceEntity of type Avatar that matches InName.
-         * @param inName - The name to search.
-         * @return A pointer to the first found match SpaceEntity.
-         */
-        findSpaceAvatar(name: string): Multiplayer.SpaceEntity;
-        /**
-         * @description Finds the first SpaceEntity of type Object that matches InName.
-         * @param inName - The name to search.
-         * @return A pointer to the first found match SpaceEntity.
-         */
-        findSpaceObject(name: string): Multiplayer.SpaceEntity;
-        /**
-         * @description Locks the entity mutex.
-         */
-        lockEntityUpdate(): void;
-        /**
-         * @description Unlocks the entity mutex.
-         */
-        unlockEntityUpdate(): void;
-        /**
-         * @description Get the number of total entities in the system (both Avatars and Objects).
-         * @return The total number of entities.
-         */
-        getNumEntities(): number;
-        /**
-         * @description Get the number of total Avatars in the system.
-         * @return The total number of Avatar entities.
-         */
-        getNumAvatars(): number;
-        /**
-         * @description Get the number of total Objects in the system.
-         * @return The total number of object entities.
-         */
-        getNumObjects(): number;
-        /**
-         * @description Get an Entity (Avatar or Object) by its index.
-         * /// Note this is not currently thread safe and should only be called from the main thread.
-         * /// @param EntityIndex size_t : The index of the entity to get.
-         * @return A pointer to the entity with the given index.
-         */
-        getEntityByIndex(entityIndex: number): Multiplayer.SpaceEntity;
-        /**
-         * @description Get an Avatar by its index.
-         * /// Note this is not currently thread safe and should only be called from the main thread.
-         * /// @param AvatarIndex size_t : The index of the avatar entity to get.
-         * @return A pointer to the avatar entity with the given index.
-         */
-        getAvatarByIndex(avatarIndex: number): Multiplayer.SpaceEntity;
-        /**
-         * @description Get an Object by its index.
-         * /// Note this is not currently thread safe and should only be called from the main thread.
-         * /// @param ObjectIndex size_t : The index of the object entity to get.
-         * @return A pointer to the object entity with the given index.
-         */
-        getObjectByIndex(objectIndex: number): 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 Sets a callback to be executed when an entity is remotely created.
-         * /// Only one callback may be registered, calling this function again will override whatever was previously set.
-         * If this is not set, some patch functions may fail.
-         * /// @param Callback EntityCreatedCallback : the callback to execute.
-         */
-        setEntityCreatedCallback(callback: (arg1: Multiplayer.SpaceEntity) => void): void;
-        /**
-         * @description Sets a callback to be executed when all existing entities have been retrieved after entering a space.
-         * @param callback - The callback to execute.
-         */
-        setInitialEntitiesRetrievedCallback(callback: (arg1: boolean) => void): void;
-        /**
-         * @description Sets a callback to be executed when the script system is ready to run scripts.
-         * @param callback - The callback to execute.
-         */
-        setScriptSystemReadyCallback(callback: (arg1: boolean) => void): void;
-        /**
-         * @description Triggers queuing of the SpaceEntities updated components and replicated data.
-         * /// Causes the replication of a SpaceEntities data on next Tick() or ProcessPendingEntityOperations(). However, this is bound by an
-         * entities rate limit and will only be replicated if there has been sufficient time since the last time the entity sent a message.
-         * /// @param EntityToUpdate SpaceEntity : A pointer to the SpaceEntity to update.
-         */
-        queueEntityUpdate(entityToUpdate: Multiplayer.SpaceEntity): void;
-        /**
-         * @description Processes pending entity operations and then calls tick on scripts if necessary.
-         */
-        tickEntities(): void;
-        registerEntityScriptAsModule(newEntity: Multiplayer.SpaceEntity): void;
-        bindNewEntityToScript(newEntity: Multiplayer.SpaceEntity): void;
-        /**
-         * @description Sets the script owner for the given entity to the current client
-         * @param entity - A pointer to the entity
-         */
-        claimScriptOwnership(entity: Multiplayer.SpaceEntity): void;
-        /**
-         * @description Adds the entity to a list of entities to be updated on tick
-         * @param entity - A pointer to the entity to be added
-         */
-        markEntityForUpdate(entity: Multiplayer.SpaceEntity): void;
-        /**
-         * @description Process pending entity adds/removes and Patch message send and receives.
-         * /// Note this should only be called from main thread
-         */
-        processPendingEntityOperations(): void;
-        /**
-         * @description Retrieves all entities from the endpoint, calls "GetAllScopedObjects" currently.
-         * /// Note this will generate new entity objects for every entity in the current scopes.
-         * If this is called by a client manually without first deleting all existing tracked entities, it is possible there will be duplicates.
-         * It is highly advised not to call this function unless you know what you are doing.
-         */
-        retrieveAllEntities(): void;
-        /**
-         * @description Destroys the client's local view of all currently known entities.
-         * /// They still reside on the server, however they will not be accessible in the client application.
-         */
-        localDestroyAllEntities(): void;
-        /**
-         * @description Sets the selected state of an entity, if the operation is acceptable.
-         * /// Criteria:
-         * For Selection:
-         * - Entity must be deselected currently
-         * For Deselection:
-         * - Entity must be selected currently
-         * - Entity must be selected by the client attempting the deselection (SpaceEntity::GetSelectingClientID will return this information)
-         * /// @param SelectedState bool : The state to set the entity to, Selected = True, Deselected = false.
-         * @param entity - A pointer to the entity to modify selection state on.
-         * @return True if a selection state change has occurred, false if no change was made (due to one of the above criteria not being met).
-         */
-        setSelectionStateOfEntity(selectedState: boolean, entity: Multiplayer.SpaceEntity): boolean;
-        /**
-         * @description Enable Leader Election feature.
-         */
-        enableLeaderElection(): void;
-        /**
-         * @description Disable Leader Election feature.
-         */
-        disableLeaderElection(): void;
-        /**
-         * @description Check if the Leader Election feature is enabled.
-         * @return True if enabled, false otherwise.
-         */
-        isLeaderElectionEnabled(): boolean;
-        /**
-         * @description Debug helper to get the id of the currently elected script leader.
-         * @return The id of the leader.
-         */
-        getLeaderId(): bigint;
-        /**
-         * @description Retrieve the state of the patch rate limiter. If true, patches are limited for each individual entity to a fixed rate.
-         * @return True if enabled, false otherwise.
-         */
-        getEntityPatchRateLimitEnabled(): boolean;
-        /**
-         * @description Set the state of the patch rate limiter. If true, patches are limited for each individual entity to a fixed rate.
-         * /// This feature is enabled by default and should only be disabled if you are encountering issues.
-         * /// @param Enabled : sets if the feature should be enabled or not.
-         * \rst
-         * .. note::
-         * If disabling this feature, more requests will be made to Magnopus Connected Services,
-         * and consequently more patch merges may occur on the server as a result.
-         * \endrst
-         */
-        setEntityPatchRateLimitEnabled(enabled: boolean): void;
-        /**
-         * @description Retrieves all entities that exist at the root level (do not have a parent entity).
-         * @return A list of root entities.
-         */
-        getRootHierarchyEntities(): Common.List<Multiplayer.SpaceEntity>;
-        delete(): void;
-    }
-}
 export declare namespace Multiplayer {
     /**
      * @description Simple class for holding the position, rotation and scale of a transform.
@@ -4972,6 +4755,58 @@ export declare namespace Systems {
         set sequences(value: Common.Array<Systems.Sequence>);
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup Status System
+   * @description Stores the version and deprecation information for a service
+   */
+    class VersionMetadata extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): VersionMetadata;
+        delete(): void;
+        get version(): string;
+        set version(value: string);
+        get deprecationDatetime(): string;
+        set deprecationDatetime(value: string);
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Status System
+   * @description Stores information about a service, including available versions
+   */
+    class ServiceStatus extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): ServiceStatus;
+        delete(): void;
+        get reverseProxy(): string;
+        set reverseProxy(value: string);
+        get name(): string;
+        set name(value: string);
+        get apiVersions(): Common.Array<Systems.VersionMetadata>;
+        set apiVersions(value: Common.Array<Systems.VersionMetadata>);
+        get currentApiVersion(): string;
+        set currentApiVersion(value: string);
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Status System
+   * @description Store information about the current service deployment
+   */
+    class ServicesDeploymentStatus extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): ServicesDeploymentStatus;
+        delete(): void;
+        get version(): string;
+        set version(value: string);
+        get services(): Common.Array<Systems.ServiceStatus>;
+        set services(value: Common.Array<Systems.ServiceStatus>);
+    }
+}
 export declare namespace Systems {
     /**
      * @description Base class for all Connected Spaces Platform Systems, which enforces passing of a WebClient or NetworkEventBus instance in the constructor
@@ -5042,6 +4877,11 @@ export declare namespace Systems {
          * @return Pointer to the log system class
          */
         getLogSystem(): Common.LogSystem;
+        /**
+         * @description Retrieves the Application Settings system.
+         * @return Pointer to the application settings system class
+         */
+        getApplicationSettingsSystem(): Systems.ApplicationSettingsSystem;
         /**
          * @description Retrieves the Settings system.
          * @return Pointer to the settings system class
@@ -5087,9 +4927,9 @@ export declare namespace Systems {
          * @return Pointer to the hotspotsequencesystem system class
          */
         getHotspotSequenceSystem(): Systems.HotspotSequenceSystem;
-        getSpaceEntitySystem(): Multiplayer.SpaceEntitySystem;
         getMultiplayerConnection(): Multiplayer.MultiplayerConnection;
         getEventBus(): Multiplayer.NetworkEventBus;
+        makeOnlineRealtimeEngine(): Multiplayer.OnlineRealtimeEngine;
     }
 }
 export declare namespace Systems {
@@ -5903,6 +5743,26 @@ export declare namespace Systems {
         set metaData(value: Common.Map<string, string>);
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup Application Settings System
+   * @description Represents configuration settings for an application context.
+   */
+    class ApplicationSettings extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): ApplicationSettings;
+        delete(): void;
+        get applicationName(): string;
+        set applicationName(value: string);
+        get context(): string;
+        set context(value: string);
+        get allowAnonymous(): boolean;
+        set allowAnonymous(value: boolean);
+        get settings(): Common.Map<string, string>;
+        set settings(value: Common.Map<string, string>);
+    }
+}
 export declare namespace Systems {
     /**
   @ingroup Settings System
@@ -6395,6 +6255,209 @@ export declare namespace Common {
         set hotspotData(value: Common.HotspotSequenceChangedNetworkEventData);
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Class for creating and managing multiplayer objects known as space entities.
+     * /// This provides functions to create and manage multiple player avatars and other objects.
+     * It manages things like queueing updated entities and triggering tick events. Callbacks
+     * can be registered for certain events that occur within the entity system so clients can
+     * react appropriately.
+     */
+    class OnlineRealtimeEngine extends Common.IRealtimeEngine implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromIRealtimeEngine(baseInstance: Common.IRealtimeEngine): Multiplayer.OnlineRealtimeEngine;
+        /**
+         * @description OnlineRealtimeEngine constructor
+         * @param inMultiplayerConnection - The multiplayer connection to construct the onlinerealtimeengine with
+         * @param logSystem - Logger such that this system can print status and debug output
+         * @param networkEventBus - Reference the the network event bus, used for leadership election messaging.
+         * @param remoteScriptRunner - Object capable of running a script. Called to execute scripts when the leader
+         * election system
+         */
+        static create_multiplayerConnection_logSystem_networkEventBus_remoteScriptRunner(multiplayerConnection: Multiplayer.MultiplayerConnection, logSystem: Common.LogSystem, networkEventBus: Multiplayer.NetworkEventBus, remoteScriptRunner: Common.IJSScriptRunner): OnlineRealtimeEngine;
+        /**
+         * @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 spaceTransform - 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, spaceTransform: 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 spaceTransform - 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, 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.
+         * @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 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 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;
+        /**
+         * @description Sets a callback to be executed when the script system is ready to run scripts.
+         * @param callback - The callback to execute.
+         */
+        setScriptLeaderReadyCallback(callback: (arg1: boolean) => void): void;
+        /**
+         * @description Sets the script owner for the given entity to the current client
+         * @param entity - A pointer to the entity
+         */
+        claimScriptOwnership(entity: Multiplayer.SpaceEntity): void;
+        /**
+         * @description Enable Leader Election feature.
+         */
+        enableLeaderElection(): void;
+        /**
+         * @description Disable Leader Election feature.
+         */
+        disableLeaderElection(): void;
+        /**
+         * @description Check if the Leader Election feature is enabled.
+         * @return True if enabled, false otherwise.
+         */
+        isLeaderElectionEnabled(): boolean;
+        /**
+         * @description Debug helper to get the id of the currently elected script leader.
+         * @return The id of the leader.
+         */
+        getLeaderId(): bigint;
+        /**
+         * @description Retrieve the state of the patch rate limiter. If true, patches are limited for each individual entity to a fixed rate.
+         * @return True if enabled, false otherwise.
+         */
+        getEntityPatchRateLimitEnabled(): boolean;
+        /**
+         * @description Set the state of the patch rate limiter. If true, patches are limited for each individual entity to a fixed rate.
+         * /// This feature is enabled by default and should only be disabled if you are encountering issues.
+         * /// @param Enabled : sets if the feature should be enabled or not.
+         * \rst
+         * .. note::
+         * If disabling this feature, more requests will be made to Magnopus Connected Services,
+         * and consequently more patch merges may occur on the server as a result.
+         * \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;
+    }
+}
 export declare namespace Multiplayer {
     /**
   @ingroup AnimatedModelSpaceComponent
@@ -9499,6 +9562,23 @@ export declare namespace Multiplayer {
         delete(): void;
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup Status System
+   * @description Data class used to contain information when a Response is received from the Status Server
+   */
+    class ServicesDeploymentStatusResult extends Systems.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Systems.ResultBase): Systems.ServicesDeploymentStatusResult;
+        /**
+         * @description Will return services deployment status for the latest available deployment from the server
+         * @return The latest services deployment status
+         */
+        getLatestServicesDeploymentStatus(): Systems.ServicesDeploymentStatus;
+        delete(): void;
+    }
+}
 export declare namespace Systems {
     /**
      * @description A result handler that is used to notify a user of an error.
@@ -11145,6 +11225,49 @@ export declare namespace Systems {
         deregisterSystemCallback(): void;
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup Application Settings System
+   * @description Represents the result of a request for application settings.
+   */
+    class ApplicationSettingsResult extends Systems.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Systems.ResultBase): Systems.ApplicationSettingsResult;
+        getApplicationSettings(): Systems.ApplicationSettings;
+        delete(): void;
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Application Settings System
+   * @description Public facing system that allows interfacing with Magnopus Connected Services' application settings service.
+   */
+    class ApplicationSettingsSystem extends Systems.SystemBase {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromSystemBase(baseInstance: Systems.SystemBase): Systems.ApplicationSettingsSystem;
+        /**
+         * @description Asynchronously retrieves application settings for a specific context.
+         * @param applicationName - The name of the application for which settings are requested.
+         * @param context - The specific context whose settings should be retrieved.
+         * @param keys - Array of setting keys to retrieve. If not provided, all settings
+         * for the context are returned.
+         * @param callback - Callback when asynchronous task finishes.
+         */
+        getSettingsByContext(applicationName: string, context: string, keys: Common.Array<string> | null): Promise<Systems.ApplicationSettingsResult>;
+        /**
+         * @description Asynchronously retrieves application settings for a specific context without requiring authentication.
+         * @param tenant - The tenant identifier under which the application and settings are scoped.
+         * @param applicationName - The name of the application for which settings are requested.
+         * @param context - The specific context whose settings should be retrieved.
+         * @param keys - Array of setting keys to retrieve. If not provided, all settings
+         * for the context are returned.
+         * @param callback - Callback when asynchronous task finishes.
+         */
+        getSettingsByContextAnonymous(tenant: string, applicationName: string, context: string, keys: Common.Array<string> | null): Promise<Systems.ApplicationSettingsResult>;
+    }
+}
 export declare namespace Systems {
     /**
   @ingroup Settings System
@@ -11522,14 +11645,18 @@ export declare namespace Systems {
         static fromSystemBase(baseInstance: Systems.SystemBase): Systems.SpaceSystem;
         /**
          * @description Enter a space if you have permission to, based on the Space settings.
-         * This includes setting scopes (and toggling event listening in order to set the scope).
-         * It also retrieves all entities in the space. Ensure Connect is called prior to this.
+         * Registers the user as in the space on the backend service, and calls csp::common::IRealtimeEngine::FetchAllEntitiesAndPopulateBuffers.
+         * 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 space - Space to enter into
+         * @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
+         * free to release the memory.
          * @param callback - Callback when asynchronous task finishes
          */
-        enterSpace(spaceId: string): Promise<Systems.NullResult>;
+        enterSpace(spaceId: string, realtimeEngine: Common.IRealtimeEngine): Promise<Systems.SpaceResult>;
         /**
          * @description Exits the space and deregisters from the space scope.
          */
@@ -12343,6 +12470,8 @@ export declare namespace Common {
         static ofcsp_systems_AssetCollection(): Array<Systems.AssetCollection>;
         static ofcsp_systems_Asset(): Array<Systems.Asset>;
         static ofcsp_systems_Sequence(): Array<Systems.Sequence>;
+        static ofcsp_systems_VersionMetadata(): Array<Systems.VersionMetadata>;
+        static ofcsp_systems_ServiceStatus(): Array<Systems.ServiceStatus>;
         static ofString(): Array<string>;
         static ofcsp_systems_EAssetPlatform(): Array<Systems.EAssetPlatform>;
         static ofcsp_systems_EAssetCollectionType(): Array<Systems.EAssetCollectionType>;
@@ -12386,6 +12515,8 @@ export declare namespace Common {
         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_VersionMetadata_number(size: number): Array<Systems.VersionMetadata>;
+        static ofcsp_systems_ServiceStatus_number(size: number): Array<Systems.ServiceStatus>;
         static ofString_number(size: number): Array<string>;
         static ofcsp_systems_EAssetPlatform_number(size: number): Array<Systems.EAssetPlatform>;
         static ofcsp_systems_EAssetCollectionType_number(size: number): Array<Systems.EAssetCollectionType>;