connected-spaces-platform.web 5.15.0 → 5.17.0

package/connectedspacesplatform.js

@@ -1999,7 +1999,7 @@ export var Multiplayer;
      * Add means the component is newly added, clients should ensure that this triggers appropriate instantiation of wrapping objects.
      * All properties for the component should be included.
      * Delete means the component has been marked for deletion. It is likely that some other clients will not have the component at the point this is
-     * recieved. Any wrapping data objects should be deleted when this is recieved, and clients should cease updating this component as any call would
+     * received. Any wrapping data objects should be deleted when this is received, and clients should cease updating this component as any call would
      * fail. The CSP representation of the component has been removed at this point.
      */
     let ComponentUpdateType;
@@ -9384,7 +9384,7 @@ export class CSPFoundation {
          * @return The type of the component as an enum.
          */
         getComponentType() {
-            let _result = Module.ccall("csp_multiplayer_ComponentBase_GetComponentType_ComponentType", "number", ["number"], [this.pointer]);
+            let _result = Module.ccall("csp_multiplayer_ComponentBase_GetComponentTypeC_ComponentType", "number", ["number"], [this.pointer]);
             return _result;
         }
         /**
@@ -9395,7 +9395,7 @@ export class CSPFoundation {
          */
         getProperties() {
             var _ret = Module._malloc(8);
-            Module.ccall("csp_multiplayer_ComponentBase_GetProperties_MapPC", "void", ["number", "number"], [_ret, this.pointer]);
+            Module.ccall("csp_multiplayer_ComponentBase_GetPropertiesC_MapPC", "void", ["number", "number"], [_ret, this.pointer]);
             var _nPtr = new Common.Map(getNativePointer(_ret), NumberFactory, "UInt32", csp_multiplayer_ReplicatedValueFactory, "csp_multiplayer_ReplicatedValue");
             Module._free(_ret);
             return _nPtr;
@@ -9547,6 +9547,12 @@ export class CSPFoundation {
         startEventMessageListening() {
             Module.ccall("csp_multiplayer_EventBus_StartEventMessageListening_void", "void", ["number"], [this.pointer]);
         }
+        delete() {
+            if (this.ownsPointer && !this.disposed) {
+                Module.ccall("csp_multiplayer_EventBus_Dtor", "void", ["number"], [this.pointer]);
+                this.disposed = true;
+            }
+        }
     }
     Multiplayer.EventBus = EventBus;
 })(Multiplayer || (Multiplayer = {}));
@@ -9916,7 +9922,7 @@ export class CSPFoundation {
         }
         /**
          * @description Sets the Self Messaging flag for this client.
-         * This allows a client to declare that it wishes to recieve every patch and object message it sends.
+         * This allows a client to declare that it wishes to receive every patch and object message it sends.
         @warning Don't use this function if you aren't sure of the consequences, it's very unlikely that a client would want to use this!
          * @param allowSelfMessaging - True to allow and false to disallow.
          * @param callback - A callback with failure state.
@@ -9943,6 +9949,12 @@ export class CSPFoundation {
             let _result = Module.ccall("csp_multiplayer_MultiplayerConnection_GetAllowSelfMessagingFlagC_bool", "boolean", ["number"], [this.pointer]);
             return _result;
         }
+        delete() {
+            if (this.ownsPointer && !this.disposed) {
+                Module.ccall("csp_multiplayer_MultiplayerConnection_Dtor", "void", ["number"], [this.pointer]);
+                this.disposed = true;
+            }
+        }
     }
     Multiplayer.MultiplayerConnection = MultiplayerConnection;
 })(Multiplayer || (Multiplayer = {}));
@@ -10469,8 +10481,8 @@ export class CSPFoundation {
             Module.ccall("csp_multiplayer_SpaceEntity_SetScale_void_Vector3RC", "void", ["number", "number"], [this.pointer, value.pointer]);
         }
         /**
-         * @description Get whether the space is transient or persistant.
-         * @return Returns true if the space is transient and false if it is marked as persistant.
+         * @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.
          */
         getIsTransient() {
             let _result = Module.ccall("csp_multiplayer_SpaceEntity_GetIsTransientC_bool", "boolean", ["number"], [this.pointer]);
@@ -10622,7 +10634,7 @@ export class CSPFoundation {
          * @description Set a callback to be executed when a patch message is received for this Entity. Only one callback can be set.
          * @param callback - Contains the SpaceEntity that updated, a set of flags to tell which parts updated
          * and an array of information to tell which components updated.
-         * When this callback is recieved, the flags and arrays should be used to determine which properties have updated data.
+         * When this callback is received, the flags and arrays should be used to determine which properties have updated data.
          */
         setUpdateCallback(callback) {
             var _callback = (_stateObject__, arg1, arg2, arg3) => {
@@ -10706,39 +10718,6 @@ export class CSPFoundation {
             assert(key <= Limits.UINT16_MAX);
             Module.ccall("csp_multiplayer_SpaceEntity_RemoveComponent_void_uint16_t", "void", ["number", "number"], [this.pointer, key]);
         }
-        /**
-         * @description Serialise local changes into patch message format into the given serialiser. Does not send a patch.
-         * @param serialiser - The serialiser to use.
-         */
-        serialisePatch(serialiser) {
-            Module.ccall("csp_multiplayer_SpaceEntity_SerialisePatchC_void_IEntitySerialiserR", "void", ["number", "number"], [this.pointer, serialiser.pointer]);
-        }
-        /**
-         * @description Serialise the entire SpaceEntity into object message format into the given serialiser. Does not send a message.
-         * @param serialiser - The serialiser to use.
-         */
-        serialise(serialiser) {
-            Module.ccall("csp_multiplayer_SpaceEntity_SerialiseC_void_IEntitySerialiserR", "void", ["number", "number"], [this.pointer, serialiser.pointer]);
-        }
-        /**
-         * @description Serialises a given component into a consistent format for the given serialiser.
-         * @param serialiser - The serialiser to use.
-         * @param component - The component to be serialised.
-         */
-        serialiseComponent(serialiser, component) {
-            Module.ccall("csp_multiplayer_SpaceEntity_SerialiseComponentC_void_IEntitySerialiserR_ComponentBaseP", "void", ["number", "number", "number"], [
-                this.pointer,
-                serialiser.pointer,
-                component.pointer,
-            ]);
-        }
-        /**
-         * @description Using the given deserialiser, populate the SpaceEntity with the data in the deserialiser.
-         * @param deserialiser - The deserialiser to use.
-         */
-        deserialise(deserialiser) {
-            Module.ccall("csp_multiplayer_SpaceEntity_Deserialise_void_IEntityDeserialiserR", "void", ["number", "number"], [this.pointer, deserialiser.pointer]);
-        }
         /**
          * @description Gets the script associated with the space entity.
          * @return The EntityScript instance set on the entity.
@@ -11243,14 +11222,14 @@ export class CSPFoundation {
          * \rst
          * .. note::
          * If disabling this feature, more requests will be made to Magnopus Connected Services,
-         * and consequntly more patch merges may occur on the server as a result.
+         * and consequently more patch merges may occur on the server as a result.
          * \endrst
          */
         setEntityPatchRateLimitEnabled(enabled) {
             Module.ccall("csp_multiplayer_SpaceEntitySystem_SetEntityPatchRateLimitEnabled_void_bool", "void", ["number", "boolean"], [this.pointer, enabled]);
         }
         /**
-         * @description Retrieves all entites that exist at the root level (do not have a parent entity).
+         * @description Retrieves all entities that exist at the root level (do not have a parent entity).
          * @return A list of root entities.
          */
         getRootHierarchyEntities() {
@@ -11260,6 +11239,12 @@ export class CSPFoundation {
             Module._free(_ret);
             return _nPtr;
         }
+        delete() {
+            if (this.ownsPointer && !this.disposed) {
+                Module.ccall("csp_multiplayer_SpaceEntitySystem_Dtor", "void", ["number"], [this.pointer]);
+                this.disposed = true;
+            }
+        }
     }
     Multiplayer.SpaceEntitySystem = SpaceEntitySystem;
 })(Multiplayer || (Multiplayer = {}));
@@ -11486,9 +11471,6 @@ export class CSPFoundation {
         }
         get verticalFov() {
             let _result = Module.ccall("csp_multiplayer_AnnotationUpdateParams__Get_VerticalFov", "number", ["number"], [this.pointer]);
-            const _unfixedValue = _result;
-            let _fixedValue = _unfixedValue < 0 ? _unfixedValue + 2 ** 16 : _unfixedValue;
-            _result = _fixedValue;
             return _result;
         }
         set verticalFov(value) {
@@ -11533,7 +11515,7 @@ export class CSPFoundation {
         }
         static create_annotationId_annotationThumbnailId_verticalFov_authorCameraPosition_authorCameraRotation(annotationId, annotationThumbnailId, verticalFov, authorCameraPosition, authorCameraRotation) {
             var _ptr = Module._malloc(8);
-            Module.ccall("csp_multiplayer_AnnotationData_Ctor_StringRC_StringRC_uint16_tC_Vector3RC_Vector4RC", "void", ["number", "string", "string", "number", "number", "number"], [
+            Module.ccall("csp_multiplayer_AnnotationData_Ctor_StringRC_StringRC_double_Vector3RC_Vector4RC", "void", ["number", "string", "string", "number", "number", "number"], [
                 _ptr,
                 annotationId,
                 annotationThumbnailId,
@@ -11550,104 +11532,50 @@ export class CSPFoundation {
             var _nPtr = getNativePointer(_ptr);
             return new AnnotationData(_nPtr);
         }
-        /**
-         * @description Get the annotation id
-         * @return Csp::common::string
-         */
-        getAnnotationId() {
-            let _result = Module.ccall("csp_multiplayer_AnnotationData_GetAnnotationIdC_String", "number", ["number"], [this.pointer]);
-            const _resultString = Module.UTF8ToString(_result);
-            free(_result);
-            _result = _resultString;
-            return _result;
+        delete() {
+            if (this.ownsPointer && !this.disposed) {
+                Module.ccall("csp_multiplayer_AnnotationData_Dtor", "void", ["number"], [this.pointer]);
+                this.disposed = true;
+            }
         }
-        /**
-         * @description Get the annotation collection id
-         * @return Csp::common::string
-         */
-        getAnnotationThumbnailId() {
-            let _result = Module.ccall("csp_multiplayer_AnnotationData_GetAnnotationThumbnailIdC_String", "number", ["number"], [this.pointer]);
-            const _resultString = Module.UTF8ToString(_result);
-            free(_result);
-            _result = _resultString;
+        get annotationId() {
+            let _result = Module.ccall("csp_multiplayer_AnnotationData__Get_AnnotationId", "string", ["number"], [this.pointer]);
             return _result;
         }
-        /**
-         * @description Get the vertical FOV
-         * @return A uint16_t representing the vertical fov
-         */
-        getVerticalFov() {
-            let _result = Module.ccall("csp_multiplayer_AnnotationData_GetVerticalFovC_uint16_t", "number", ["number"], [this.pointer]);
-            const _unfixedValue = _result;
-            let _fixedValue = _unfixedValue < 0 ? _unfixedValue + 2 ** 16 : _unfixedValue;
-            _result = _fixedValue;
+        set annotationId(value) {
+            Module.ccall("csp_multiplayer_AnnotationData__Set_AnnotationId", "void", ["number", "string"], [this.pointer, value]);
+        }
+        get annotationThumbnailId() {
+            let _result = Module.ccall("csp_multiplayer_AnnotationData__Get_AnnotationThumbnailId", "string", ["number"], [this.pointer]);
             return _result;
         }
-        /**
-         * @description Get the AuthorCameraPosition
-         * @return A vector3 representing the authorcameraposition
-         */
-        getAuthorCameraPosition() {
-            var _ret = Module._malloc(8);
-            Module.ccall("csp_multiplayer_AnnotationData_GetAuthorCameraPositionC_Vector3", "void", ["number", "number"], [_ret, this.pointer]);
-            var _nPtr = new Common.Vector3(getNativePointer(_ret));
-            Module._free(_ret);
-            return _nPtr;
+        set annotationThumbnailId(value) {
+            Module.ccall("csp_multiplayer_AnnotationData__Set_AnnotationThumbnailId", "void", ["number", "string"], [this.pointer, value]);
         }
-        /**
-         * @description Get the AuthorCameraRotation
-         * @return A vector4 representing the authorcamerarotation
-         */
-        getAuthorCameraRotation() {
-            var _ret = Module._malloc(8);
-            Module.ccall("csp_multiplayer_AnnotationData_GetAuthorCameraRotationC_Vector4", "void", ["number", "number"], [_ret, this.pointer]);
-            var _nPtr = new Common.Vector4(getNativePointer(_ret));
-            Module._free(_ret);
-            return _nPtr;
-        }
-        /**
-         * @description Set the annotation id
-         * @param id - Const csp::common::string& id
-         */
-        setAnnotationId(id) {
-            Module.ccall("csp_multiplayer_AnnotationData_SetAnnotationId_void_StringRC", "void", ["number", "string"], [this.pointer, id]);
+        get verticalFov() {
+            let _result = Module.ccall("csp_multiplayer_AnnotationData__Get_VerticalFov", "number", ["number"], [this.pointer]);
+            return _result;
         }
-        /**
-         * @description Set the annotation collection id
-         * @param id - Const csp::common::string& id
-         */
-        setAnnotationThumbnailId(id) {
-            Module.ccall("csp_multiplayer_AnnotationData_SetAnnotationThumbnailId_void_StringRC", "void", ["number", "string"], [this.pointer, id]);
+        set verticalFov(value) {
+            Module.ccall("csp_multiplayer_AnnotationData__Set_VerticalFov", "void", ["number", "number"], [this.pointer, value]);
         }
-        /**
-         * @description Set the VerticalFov
-         * @param inVerticalFo - InVerticalFov
-         */
-        setVerticalFov(verticalFov) {
-            assert(Number.isInteger(verticalFov));
-            assert(verticalFov >= Limits.UINT16_MIN);
-            assert(verticalFov <= Limits.UINT16_MAX);
-            Module.ccall("csp_multiplayer_AnnotationData_SetVerticalFov_void_uint16_tC", "void", ["number", "number"], [this.pointer, verticalFov]);
+        get authorCameraPosition() {
+            const _ptr = Module._malloc(8);
+            Module.ccall("csp_multiplayer_AnnotationData__Get_AuthorCameraPosition", "void", ["number", "number"], [_ptr, this.pointer]);
+            const _nPtr = getNativePointer(_ptr);
+            return new Common.Vector3(_nPtr);
         }
-        /**
-         * @description Set the AuthorCameraPosition
-         * @param inAuthorCameraPositio - InAuthorCameraPosition
-         */
-        setAuthorCameraPosition(authorCameraPosition) {
-            Module.ccall("csp_multiplayer_AnnotationData_SetAuthorCameraPosition_void_Vector3RC", "void", ["number", "number"], [this.pointer, authorCameraPosition.pointer]);
+        set authorCameraPosition(value) {
+            Module.ccall("csp_multiplayer_AnnotationData__Set_AuthorCameraPosition", "void", ["number", "number"], [this.pointer, value.pointer]);
         }
-        /**
-         * @description Set the AuthorCameraRotation
-         * @param inAuthorCameraRotatio - InAuthorCameraRotation
-         */
-        setAuthorCameraRotation(authorCameraRotation) {
-            Module.ccall("csp_multiplayer_AnnotationData_SetAuthorCameraRotation_void_Vector4RC", "void", ["number", "number"], [this.pointer, authorCameraRotation.pointer]);
+        get authorCameraRotation() {
+            const _ptr = Module._malloc(8);
+            Module.ccall("csp_multiplayer_AnnotationData__Get_AuthorCameraRotation", "void", ["number", "number"], [_ptr, this.pointer]);
+            const _nPtr = getNativePointer(_ptr);
+            return new Common.Vector4(_nPtr);
         }
-        delete() {
-            if (this.ownsPointer && !this.disposed) {
-                Module.ccall("csp_multiplayer_AnnotationData_Dtor", "void", ["number"], [this.pointer]);
-                this.disposed = true;
-            }
+        set authorCameraRotation(value) {
+            Module.ccall("csp_multiplayer_AnnotationData__Set_AuthorCameraRotation", "void", ["number", "number"], [this.pointer, value.pointer]);
         }
     }
     Multiplayer.AnnotationData = AnnotationData;
@@ -11702,6 +11630,14 @@ export class CSPFoundation {
             let _result = Module.ccall("csp_multiplayer_EntityScript_HasError_bool", "boolean", ["number"], [this.pointer]);
             return _result;
         }
+        /**
+         * @description Checks if the entity has a script component.
+         * @return True if component exist, false otherwise.
+         */
+        hasEntityScriptComponent() {
+            let _result = Module.ccall("csp_multiplayer_EntityScript_HasEntityScriptComponent_bool", "boolean", ["number"], [this.pointer]);
+            return _result;
+        }
         /**
          * @description Gets the text of the last error if it is known or otherwise returns a default unknown error string.
          * @return Text of the last error.
@@ -17582,13 +17518,24 @@ export class CSPFoundation {
         @pre This component must contain a valid conversation id (component must have a conversation id that isn't an empty string).
          * A CSP error will be sent to the LogSystem if this condition is not met, with a EResultCode::Failed response.
          */
-        getAnnotationThumbnailsForConversation(callback) {
+        async getAnnotationThumbnailsForConversation() {
+            var _resolve;
+            var _promise = new Promise((_r) => {
+                _resolve = _r;
+            });
+            var _callbackPtr;
             var _callback = (_stateObject__, result) => {
-                var _result = new Multiplayer.AnnotationThumbnailCollectionResult(getNativePointer(result));
-                callback(_result);
+                var _resultPtr = getNativePointer(result);
+                var _resultInstance = new Multiplayer.AnnotationThumbnailCollectionResult(_resultPtr);
+                if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
+                    return;
+                }
+                _resolve(_resultInstance);
+                Module.removeFunction(_callbackPtr);
             };
-            var callbackPtr = Module.addFunction(_callback, "vii");
-            Module.ccall("csp_multiplayer_ConversationSpaceComponent_GetAnnotationThumbnailsForConversation_void_AnnotationThumbnailCollectionResultCallback", "void", ["number", "number"], [this.pointer, callbackPtr]);
+            _callbackPtr = Module.addFunction(_callback, "vii");
+            Module.ccall("csp_multiplayer_ConversationSpaceComponent_GetAnnotationThumbnailsForConversation_void_AnnotationThumbnailCollectionResultCallback", "void", ["number", "number", "number"], [this.pointer, _callbackPtr, 0]);
+            return _promise;
         }
         /**
          * @description Sets a callback for when the conversation is updated by another client.
@@ -21610,6 +21557,12 @@ export class CSPFoundation {
             Module._free(_ret);
             return _nPtr;
         }
+        static create() {
+            var _ptr = Module._malloc(8);
+            Module.ccall("csp_systems_AssetCollectionResult_Ctor", "void", ["number"], [_ptr]);
+            var _nPtr = getNativePointer(_ptr);
+            return new AssetCollectionResult(_nPtr);
+        }
         delete() {
             if (this.ownsPointer && !this.disposed) {
                 Module.ccall("csp_systems_AssetCollectionResult_Dtor", "void", ["number"], [this.pointer]);
@@ -25900,6 +25853,12 @@ export class CSPFoundation {
             _result = _resultString;
             return _result;
         }
+        static create() {
+            var _ptr = Module._malloc(8);
+            Module.ccall("csp_systems_SpaceResult_Ctor", "void", ["number"], [_ptr]);
+            var _nPtr = getNativePointer(_ptr);
+            return new SpaceResult(_nPtr);
+        }
         delete() {
             if (this.ownsPointer && !this.disposed) {
                 Module.ccall("csp_systems_SpaceResult_Dtor", "void", ["number"], [this.pointer]);
@@ -26444,7 +26403,7 @@ export class CSPFoundation {
             return _promise;
         }
         /**
-         * @description Deletes a given space and the corresponding UserService group.
+         * @description Deletes a given space and the associated objects that belong to it. Including UserService group, Metadata, and Thumbnail.
          * @param space - Space to delete
          * @param callback - Callback when asynchronous task finishes
          */