connected-spaces-platform.web 5.17.0 → 5.17.2

package/connectedspacesplatform.d.ts

@@ -98,6 +98,15 @@ export declare namespace Common {
         Vector4 = 6
     }
 }
+export declare namespace Common {
+    /**
+     * @description Enum of concrete types of RealtimeEngines.
+     */
+    enum RealtimeEngineType {
+        OnlineMultiUser = 0,
+        OnlineSingleUser = 1
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Represents the type of component.
@@ -3482,6 +3491,128 @@ export declare namespace Common {
         set w(value: number);
     }
 }
+export declare namespace Common {
+    class IRealtimeEngine extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        /**
+         * @description Virtual destructor.
+         */
+        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 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, spaceTransform: Multiplayer.SpaceTransform, 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 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>;
+        /**
+         * @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 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.
+         */
+        setInitialEntitiesRetrievedCallback(callback: (arg1: boolean) => 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 Multiplayer {
     /**
      * @description The base class for all components, provides mechanisms for dirtying properties and subscribing to events on property changes.

package/connectedspacesplatform.js

@@ -269,6 +269,11 @@ function csp_common_VariantTypeFactory(nativePointer) {
     return nativePointer.pointer;
 }
 ProxyClassFactories["csp_common_VariantType"] = csp_common_VariantTypeFactory;
+function csp_common_RealtimeEngineTypeFactory(nativePointer) {
+    return nativePointer.pointer;
+}
+ProxyClassFactories["csp_common_RealtimeEngineType"] =
+    csp_common_RealtimeEngineTypeFactory;
 function csp_multiplayer_ComponentTypeFactory(nativePointer) {
     return nativePointer.pointer;
 }
@@ -695,6 +700,11 @@ function csp_common_Vector4Factory(nativePointer) {
     return new Common.Vector4(nativePointer);
 }
 ProxyClassFactories["csp_common_Vector4"] = csp_common_Vector4Factory;
+function csp_common_IRealtimeEngineFactory(nativePointer) {
+    return new Common.IRealtimeEngine(nativePointer);
+}
+ProxyClassFactories["csp_common_IRealtimeEngine"] =
+    csp_common_IRealtimeEngineFactory;
 function csp_multiplayer_ComponentBaseFactory(nativePointer) {
     return new Multiplayer.ComponentBase(nativePointer);
 }
@@ -1858,6 +1868,16 @@ export var Common;
         VariantType[VariantType["Vector4"] = 6] = "Vector4";
     })(VariantType = Common.VariantType || (Common.VariantType = {}));
 })(Common || (Common = {}));
+(function (Common) {
+    /**
+     * @description Enum of concrete types of RealtimeEngines.
+     */
+    let RealtimeEngineType;
+    (function (RealtimeEngineType) {
+        RealtimeEngineType[RealtimeEngineType["OnlineMultiUser"] = 0] = "OnlineMultiUser";
+        RealtimeEngineType[RealtimeEngineType["OnlineSingleUser"] = 1] = "OnlineSingleUser";
+    })(RealtimeEngineType = Common.RealtimeEngineType || (Common.RealtimeEngineType = {}));
+})(Common || (Common = {}));
 export var Multiplayer;
 (function (Multiplayer) {
     /**
@@ -9348,6 +9368,294 @@ export class CSPFoundation {
     }
     Common.Vector4 = Vector4;
 })(Common || (Common = {}));
+(function (Common) {
+    class IRealtimeEngine extends NativeClassWrapper {
+        /** @internal */
+        constructor(pointer) {
+            super(pointer);
+        }
+        /**
+         * @description Virtual destructor.
+         */
+        delete() {
+            if (this.ownsPointer && !this.disposed) {
+                Module.ccall("csp_common_IRealtimeEngine_Dtor", "void", ["number"], [this.pointer]);
+                this.disposed = true;
+            }
+        }
+        /**
+         * @description Returns the concrete type of the instantiation of the abstract IRealtimeEngine.
+         */
+        getRealtimeEngineType() {
+            let _result = Module.ccall("csp_common_IRealtimeEngine_GetRealtimeEngineTypeC_RealtimeEngineType", "number", ["number"], [this.pointer]);
+            return _result;
+        }
+        /**
+         * @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 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.
+         */
+        async createAvatar(name, spaceTransform, state, avatarId, avatarPlayMode) {
+            var _resolve;
+            var _promise = new Promise((_r) => {
+                _resolve = _r;
+            });
+            var _callbackPtr;
+            var _callback = (_stateObject__, arg1) => {
+                var _arg1Ptr = getNativePointer(arg1);
+                var _arg1Instance = new Multiplayer.SpaceEntity(_arg1Ptr);
+                _resolve(_arg1Instance);
+                Module.removeFunction(_callbackPtr);
+            };
+            _callbackPtr = Module.addFunction(_callback, "vii");
+            Module.ccall("csp_common_IRealtimeEngine_CreateAvatar_void_StringRC_SpaceTransformRC_AvatarStateRC_StringRC_AvatarPlayModeRC_EntityCreatedCallback", "void", [
+                "number",
+                "string",
+                "number",
+                "number",
+                "string",
+                "number",
+                "number",
+                "number",
+            ], [
+                this.pointer,
+                name,
+                spaceTransform.pointer,
+                state,
+                avatarId,
+                avatarPlayMode,
+                _callbackPtr,
+                0,
+            ]);
+            return _promise;
+        }
+        /**
+         * @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 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.
+         */
+        async createEntity(name, spaceTransform) {
+            var _resolve;
+            var _promise = new Promise((_r) => {
+                _resolve = _r;
+            });
+            var _callbackPtr;
+            var _callback = (_stateObject__, arg1) => {
+                var _arg1Ptr = getNativePointer(arg1);
+                var _arg1Instance = new Multiplayer.SpaceEntity(_arg1Ptr);
+                _resolve(_arg1Instance);
+                Module.removeFunction(_callbackPtr);
+            };
+            _callbackPtr = Module.addFunction(_callback, "vii");
+            Module.ccall("csp_common_IRealtimeEngine_CreateEntity_void_StringRC_SpaceTransformRC_EntityCreatedCallback", "void", ["number", "string", "number", "number", "number"], [this.pointer, name, spaceTransform.pointer, _callbackPtr, 0]);
+            return _promise;
+        }
+        /**
+         * @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.
+         */
+        async destroyEntity(entity) {
+            var _resolve;
+            var _promise = new Promise((_r) => {
+                _resolve = _r;
+            });
+            var _callbackPtr;
+            var _callback = (_stateObject__, arg1) => {
+                _resolve(!!arg1);
+                Module.removeFunction(_callbackPtr);
+            };
+            _callbackPtr = Module.addFunction(_callback, "vii");
+            Module.ccall("csp_common_IRealtimeEngine_DestroyEntity_void_SpaceEntityP_CallbackHandler", "void", ["number", "number", "number", "number"], [this.pointer, entity.pointer, _callbackPtr, 0]);
+            return _promise;
+        }
+        /**
+         * @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) {
+            var _callback = (_stateObject__, arg1) => {
+                var _arg1 = new Multiplayer.SpaceEntity(getNativePointer(arg1));
+                callback(_arg1);
+            };
+            var _callbackPtr = Module.addFunction(_callback, "vii");
+            Module.ccall("csp_common_IRealtimeEngine_SetEntityCreatedCallback_void_EntityCreatedCallback", "void", ["number", "number", "number"], [this.pointer, _callbackPtr, 0]);
+        }
+        /**
+         * @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) {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_IRealtimeEngine_FindSpaceEntity_SpaceEntityP_StringRC", "void", ["number", "number", "string"], [_ret, this.pointer, name]);
+            var _nPtr = new Multiplayer.SpaceEntity(getNativePointer(_ret));
+            Module._free(_ret);
+            return _nPtr;
+        }
+        /**
+         * @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) {
+            assert(entityId >= Limits.UINT64_MIN);
+            assert(entityId <= Limits.UINT64_MAX);
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_IRealtimeEngine_FindSpaceEntityById_SpaceEntityP_uint64_t", "void", ["number", "number", "bigint"], [_ret, this.pointer, entityId]);
+            var _nPtr = new Multiplayer.SpaceEntity(getNativePointer(_ret));
+            Module._free(_ret);
+            return _nPtr;
+        }
+        /**
+         * @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) {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_IRealtimeEngine_FindSpaceAvatar_SpaceEntityP_StringRC", "void", ["number", "number", "string"], [_ret, this.pointer, name]);
+            var _nPtr = new Multiplayer.SpaceEntity(getNativePointer(_ret));
+            Module._free(_ret);
+            return _nPtr;
+        }
+        /**
+         * @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) {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_IRealtimeEngine_FindSpaceObject_SpaceEntityP_StringRC", "void", ["number", "number", "string"], [_ret, this.pointer, name]);
+            var _nPtr = new Multiplayer.SpaceEntity(getNativePointer(_ret));
+            Module._free(_ret);
+            return _nPtr;
+        }
+        /**
+         * @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) {
+            assert(Number.isInteger(entityIndex));
+            assert(entityIndex >= Limits.UINT32_MIN);
+            assert(entityIndex <= Limits.UINT32_MAX);
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_IRealtimeEngine_GetEntityByIndex_SpaceEntityP_size_t", "void", ["number", "number", "number"], [_ret, this.pointer, entityIndex]);
+            var _nPtr = new Multiplayer.SpaceEntity(getNativePointer(_ret));
+            Module._free(_ret);
+            return _nPtr;
+        }
+        /**
+         * @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) {
+            assert(Number.isInteger(avatarIndex));
+            assert(avatarIndex >= Limits.UINT32_MIN);
+            assert(avatarIndex <= Limits.UINT32_MAX);
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_IRealtimeEngine_GetAvatarByIndex_SpaceEntityP_size_t", "void", ["number", "number", "number"], [_ret, this.pointer, avatarIndex]);
+            var _nPtr = new Multiplayer.SpaceEntity(getNativePointer(_ret));
+            Module._free(_ret);
+            return _nPtr;
+        }
+        /**
+         * @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) {
+            assert(Number.isInteger(objectIndex));
+            assert(objectIndex >= Limits.UINT32_MIN);
+            assert(objectIndex <= Limits.UINT32_MAX);
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_IRealtimeEngine_GetObjectByIndex_SpaceEntityP_size_t", "void", ["number", "number", "number"], [_ret, this.pointer, objectIndex]);
+            var _nPtr = new Multiplayer.SpaceEntity(getNativePointer(_ret));
+            Module._free(_ret);
+            return _nPtr;
+        }
+        /**
+         * @description Get the number of total entities in the system.
+         * @return The total number of entities.
+         */
+        getNumEntities() {
+            let _result = Module.ccall("csp_common_IRealtimeEngine_GetNumEntitiesC_size_t", "number", ["number"], [this.pointer]);
+            const _unfixedValue = _result;
+            let _fixedValue = _unfixedValue < 0 ? _unfixedValue + 2 ** 32 : _unfixedValue;
+            _result = _fixedValue;
+            return _result;
+        }
+        /**
+         * @description Get the number of total Avatars in the system. Avatars are entities that contain AvatarSpaceComponents.
+         * @return The total number of Avatar entities.
+         */
+        getNumAvatars() {
+            let _result = Module.ccall("csp_common_IRealtimeEngine_GetNumAvatarsC_size_t", "number", ["number"], [this.pointer]);
+            const _unfixedValue = _result;
+            let _fixedValue = _unfixedValue < 0 ? _unfixedValue + 2 ** 32 : _unfixedValue;
+            _result = _fixedValue;
+            return _result;
+        }
+        /**
+         * @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() {
+            let _result = Module.ccall("csp_common_IRealtimeEngine_GetNumObjectsC_size_t", "number", ["number"], [this.pointer]);
+            const _unfixedValue = _result;
+            let _fixedValue = _unfixedValue < 0 ? _unfixedValue + 2 ** 32 : _unfixedValue;
+            _result = _fixedValue;
+            return _result;
+        }
+        /**
+         * @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() {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_IRealtimeEngine_GetRootHierarchyEntitiesC_ListPC", "void", ["number", "number"], [_ret, this.pointer]);
+            var _nPtr = new Common.List(getNativePointer(_ret), csp_multiplayer_SpaceEntityFactory, "csp_multiplayer_SpaceEntity");
+            Module._free(_ret);
+            return _nPtr;
+        }
+        /**
+         * @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.
+         */
+        setInitialEntitiesRetrievedCallback(callback) {
+            var _callback = (_stateObject__, arg1) => {
+                callback(arg1);
+            };
+            var _callbackPtr = Module.addFunction(_callback, "vii");
+            Module.ccall("csp_common_IRealtimeEngine_SetInitialEntitiesRetrievedCallback_void_CallbackHandler", "void", ["number", "number", "number"], [this.pointer, _callbackPtr, 0]);
+        }
+        /**
+         * @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) {
+            Module.ccall("csp_common_IRealtimeEngine_MarkEntityForUpdate_void_SpaceEntityP", "void", ["number", "number"], [this.pointer, entity.pointer]);
+        }
+        /**
+         * @description Applies any pending changes to entities that have been marked for update.
+         */
+        processPendingEntityOperations() {
+            Module.ccall("csp_common_IRealtimeEngine_ProcessPendingEntityOperations_void", "void", ["number"], [this.pointer]);
+        }
+    }
+    Common.IRealtimeEngine = IRealtimeEngine;
+})(Common || (Common = {}));
 (function (Multiplayer) {
     /**
      * @description The base class for all components, provides mechanisms for dirtying properties and subscribing to events on property changes.