connected-spaces-platform.web 5.15.0 → 5.17.0

package/connectedspacesplatform.d.ts

@@ -229,7 +229,7 @@ export declare namespace 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.
      */
     enum ComponentUpdateType {
@@ -1250,235 +1250,6 @@ export declare namespace Web {
         ResponseNetworkAuthenticationRequired = 511
     }
 }
-export declare namespace Multiplayer {
-    /**
-     * @description The serialiser is responsible for converting a SpaceEntity instance into a data structure that both SignalR
-     * and our servers can understand and use.
-     * /// To use the serialiser, Start with BeginEntity(), then use the write(bool, int, etc) functions to write data at the
-     * Entity level. Use BeginComponents() to start writing as the Server component data, with each BeginComponent and
-     * EndComponent brace dictating information written into a server component. Within a component, use WriteProperty()
-     * to write the individual data. Ensure you finish by closing out the relevant sections with the 'End' functions.
-     */
-    interface IEntitySerialiser {
-        /**
-         * @description Start the serialisiation.
-         */
-        beginEntity: () => void;
-        /**
-         * @description End the serialisiation.
-         */
-        endEntity: () => void;
-        /**
-         * @description Write a boolean field of the entity.
-         * @param value - The value to write.
-         */
-        writeBool: (value: boolean) => void;
-        /**
-         * @description Write a byte field of the entity.
-         * @param value - The value to write.
-         */
-        writeByte: (value: number) => void;
-        /**
-         * @description Write a double field of the entity.
-         * @param value - The value to write.
-         */
-        writeDouble: (value: number) => void;
-        /**
-         * @description Write an int64_t field of the entity.
-         * @param value - The value to write.
-         */
-        writeInt64: (value: bigint) => void;
-        /**
-         * @description Write a uint64_t field of the entity.
-         * @param value - The value to write.
-         */
-        writeUInt64: (value: bigint) => void;
-        /**
-         * @description Write a string field of the entity.
-         * @param value - The value to write.
-         */
-        writeString: (value: string) => void;
-        /**
-         * @description Write a null field of the entity.
-         */
-        writeNull: () => void;
-        /**
-         * @description Start an array section.
-         */
-        beginArray: () => void;
-        /**
-         * @description Finish an array section.
-         */
-        endArray: () => void;
-        /**
-         * @description Start the components section.
-         */
-        beginComponents: () => void;
-        /**
-         * @description Finish the components section
-         */
-        endComponents: () => void;
-        /**
-         * @description Begin writing component with the given ID and type.
-         * @param id - The ID of the component.
-         */
-        beginComponent: (id: number, type: bigint) => void;
-        /**
-         * @description Finish a component section.
-         */
-        endComponent: () => void;
-        /**
-         * @description Write the given component property.
-         * @param id - ID of the component property.
-         * @param value - The value to be written.
-         */
-        writeProperty: (id: bigint, value: Multiplayer.ReplicatedValue) => void;
-        /**
-         * @description Specific handler for writing view components.
-         * /// View Components are data that is stored in specific keys on the server, it allows us to discretely update these
-         * singular data pieces, rather than replicating larger chunks of data, and also allows us to always know where
-         * in a data structure this data will be.
-         * /// @param Id uint16_t : The ID of the component
-         * @param value - The value of the component data to add
-         */
-        addViewComponent: (id: number, value: Multiplayer.ReplicatedValue) => void;
-    }
-}
-export declare namespace Multiplayer {
-    /**
-     * @description The deserialiser is used to take recieved signalr message data and turn it into values you can use to populate a SpaceEntity.
-     * /// This works similarly to the serialiser and you can refer to the serialiser for more details.
-     * It is expected that you will be using the data as you read it to populate either a newly created or currently existing SpaceEntity.
-     */
-    interface IEntityDeserialiser {
-        /**
-         * @description Starts the deserialisation.
-         */
-        enterEntity: () => void;
-        /**
-         * @description Ends the deserialisation.
-         */
-        leaveEntity: () => void;
-        /**
-         * @description Reads a boolean from the deserialiser.
-         * @return The deserialised boolean.
-         */
-        readBool: () => boolean;
-        /**
-         * @description Reads a byte from the deserialiser.
-         * @return The deserialised byte.
-         */
-        readByte: () => number;
-        /**
-         * @description Reads a double from the deserialiser.
-         * @return The deserialised double.
-         */
-        readDouble: () => number;
-        /**
-         * @description Reads an int64_t from the deserialiser.
-         * @return The deserialised boolean.
-         */
-        readInt64: () => bigint;
-        /**
-         * @description Reads a uint64_t from the deserialiser.
-         * @return The deserialised uint64_t.
-         */
-        readUInt64: () => bigint;
-        /**
-         * @description Reads a string from the deserialiser.
-         * @return The deserialised string.
-         */
-        readString: () => string;
-        /**
-         * @description Reads a vector2 from the deserialiser.
-         * @return The deserialised vector2.
-         */
-        readVector2: () => Common.Vector2;
-        /**
-         * @description Reads a vector3 from the deserialiser.
-         * @return The deserialised vector3.
-         */
-        readVector3: () => Common.Vector3;
-        /**
-         * @description Reads a vector4 from the deserialiser.
-         * @return The deserialised vector4.
-         */
-        readVector4: () => Common.Vector4;
-        /**
-         * @description Checks if the next value is null.
-         * @return True if the next value is null, false otherwise.
-         */
-        nextValueIsNull: () => boolean;
-        /**
-         * @description Checks if the next value is an array.
-         * @return True if the next value is null, false otherwise.
-         */
-        nextValueIsArray: () => boolean;
-        /**
-         * @description Puts the deserialiser into array processing mode to begin reading from an array.
-         * @param outLength - A reference to variable to store the length of the array.
-         */
-        enterArray: (outLength: NativeRef) => void;
-        /**
-         * @description Completes reading from and array and leaves the array processing mode.
-         */
-        leaveArray: () => void;
-        /**
-         * @description Puts the deserialiser into component processing mode to begin reading from the components section of the serialised entity.
-         */
-        enterComponents: () => void;
-        /**
-         * @description Completes reading the components and exits that mode.
-         */
-        leaveComponents: () => void;
-        /**
-         * @description Gets the total number of components, including view components.
-         * /// If iterating components by this count, subtract number of view components.
-         * /// @return The number of components.
-         */
-        getNumComponents: () => bigint;
-        /**
-         * @description Gets the number of components that are not view components.
-         * @return The number of non-view components.
-         */
-        getNumRealComponents: () => bigint;
-        /**
-         * @description Begins the processes of deserialising a single component that is not a view component.
-         */
-        enterComponent: (outId: NativeRef, outType: NativeRef) => void;
-        /**
-         * @description Completes the deserialisation of a single component.
-         */
-        leaveComponent: () => void;
-        /**
-         * @description Gets the number of properties in the component that is currently being deserialised.
-         * @return The number of properties in the component.
-         */
-        getNumProperties: () => bigint;
-        /**
-         * @description Reads a property from the deserialiser, returning it as a ReplicatedValue.
-         * @param outId - A reference to a variable to store the ID of the property.
-         * @return The property value.
-         */
-        readProperty: (outId: NativeRef) => Multiplayer.ReplicatedValue;
-        /**
-         * @description Reads a view component from the deserialiser, returning it as a ReplicatedValue.
-         * /// Since view components are handled differently in the serialiser, they are similarly deserialised in their own way.
-         * /// @return The view component value.
-         */
-        getViewComponent: (id: number) => Multiplayer.ReplicatedValue;
-        /**
-         * @description Gets whether there is a view component with the given ID.
-         * @param id - The ID of the component.
-         * @return True if there is a view component, false otherwise.
-         */
-        hasViewComponent: (id: number) => boolean;
-        /**
-         * @description Skips a field when deserialising the SpaceEntity fields.
-         */
-        skip: () => void;
-    }
-}
 export declare namespace Multiplayer {
     /**
      * @description Controls whether a component is enabled or disabled.
@@ -3780,7 +3551,7 @@ export declare namespace Multiplayer {
   @ingroup Multiplayer
    * @description Handling of all network events.
    */
-    class EventBus extends NativeClassWrapper {
+    class EventBus extends NativeClassWrapper implements INativeResource {
         /** @internal */
         constructor(pointer: NativePointer);
         /**
@@ -3814,6 +3585,7 @@ export declare namespace Multiplayer {
          * @description Instructs the event bus to start listening to messages
          */
         startEventMessageListening(): void;
+        delete(): void;
     }
 }
 export declare namespace Multiplayer {
@@ -3920,7 +3692,7 @@ export declare namespace Multiplayer {
   @ingroup Multiplayer
    * @description Handling of all multiplayer connection functionality, such as connect, disconnect, entity replication and network events.
    */
-    class MultiplayerConnection extends NativeClassWrapper {
+    class MultiplayerConnection extends NativeClassWrapper implements INativeResource {
         /** @internal */
         constructor(pointer: NativePointer);
         /**
@@ -3951,7 +3723,7 @@ export declare namespace Multiplayer {
         getConnectionState(): Multiplayer.ConnectionState;
         /**
          * @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.
@@ -3962,6 +3734,7 @@ export declare namespace Multiplayer {
          * @return True if self messaging is allowed, false otherwise.
          */
         getAllowSelfMessagingFlag(): boolean;
+        delete(): void;
     }
 }
 export declare namespace Multiplayer {
@@ -4245,8 +4018,8 @@ export declare namespace Multiplayer {
          */
         setScale(value: Common.Vector3): void;
         /**
-         * @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(): boolean;
         /**
@@ -4325,7 +4098,7 @@ export declare namespace Multiplayer {
          * @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: (arg1: Multiplayer.SpaceEntity, arg2: Multiplayer.SpaceEntityUpdateFlags, arg3: Common.Array<Multiplayer.ComponentUpdateInfo>) => void): void;
         /**
@@ -4363,27 +4136,6 @@ export declare namespace Multiplayer {
          * /// @param Key uint16_t : The component ID of the component to remove.
          */
         removeComponent(key: number): void;
-        /**
-         * @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: Multiplayer.IEntitySerialiser): void;
-        /**
-         * @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: Multiplayer.IEntitySerialiser): void;
-        /**
-         * @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: Multiplayer.IEntitySerialiser, component: Multiplayer.ComponentBase): void;
-        /**
-         * @description Using the given deserialiser, populate the SpaceEntity with the data in the deserialiser.
-         * @param deserialiser - The deserialiser to use.
-         */
-        deserialise(deserialiser: Multiplayer.IEntityDeserialiser): void;
         /**
          * @description Gets the script associated with the space entity.
          * @return The EntityScript instance set on the entity.
@@ -4449,7 +4201,7 @@ export declare namespace Multiplayer {
      * can be registered for certain events that occur within the entity system so clients can
      * react appropriately.
      */
-    class SpaceEntitySystem extends NativeClassWrapper {
+    class SpaceEntitySystem extends NativeClassWrapper implements INativeResource {
         /** @internal */
         constructor(pointer: NativePointer);
         /**
@@ -4658,15 +4410,16 @@ export declare namespace Multiplayer {
          * \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: boolean): void;
         /**
-         * @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(): Common.List<Multiplayer.SpaceEntity>;
+        delete(): void;
     }
 }
 export declare namespace Multiplayer {
@@ -4779,57 +4532,17 @@ export declare namespace Multiplayer {
         static create(): AnnotationData;
         static create_annotationId_annotationThumbnailId_verticalFov_authorCameraPosition_authorCameraRotation(annotationId: string, annotationThumbnailId: string, verticalFov: number, authorCameraPosition: Common.Vector3, authorCameraRotation: Common.Vector4): AnnotationData;
         static create_annotationData(annotationData: Multiplayer.AnnotationData): AnnotationData;
-        /**
-         * @description Get the annotation id
-         * @return Csp::common::string
-         */
-        getAnnotationId(): string;
-        /**
-         * @description Get the annotation collection id
-         * @return Csp::common::string
-         */
-        getAnnotationThumbnailId(): string;
-        /**
-         * @description Get the vertical FOV
-         * @return A uint16_t representing the vertical fov
-         */
-        getVerticalFov(): number;
-        /**
-         * @description Get the AuthorCameraPosition
-         * @return A vector3 representing the authorcameraposition
-         */
-        getAuthorCameraPosition(): Common.Vector3;
-        /**
-         * @description Get the AuthorCameraRotation
-         * @return A vector4 representing the authorcamerarotation
-         */
-        getAuthorCameraRotation(): Common.Vector4;
-        /**
-         * @description Set the annotation id
-         * @param id - Const csp::common::string& id
-         */
-        setAnnotationId(id: string): void;
-        /**
-         * @description Set the annotation collection id
-         * @param id - Const csp::common::string& id
-         */
-        setAnnotationThumbnailId(id: string): void;
-        /**
-         * @description Set the VerticalFov
-         * @param inVerticalFo - InVerticalFov
-         */
-        setVerticalFov(verticalFov: number): void;
-        /**
-         * @description Set the AuthorCameraPosition
-         * @param inAuthorCameraPositio - InAuthorCameraPosition
-         */
-        setAuthorCameraPosition(authorCameraPosition: Common.Vector3): void;
-        /**
-         * @description Set the AuthorCameraRotation
-         * @param inAuthorCameraRotatio - InAuthorCameraRotation
-         */
-        setAuthorCameraRotation(authorCameraRotation: Common.Vector4): void;
         delete(): void;
+        get annotationId(): string;
+        set annotationId(value: string);
+        get annotationThumbnailId(): string;
+        set annotationThumbnailId(value: string);
+        get verticalFov(): number;
+        set verticalFov(value: number);
+        get authorCameraPosition(): Common.Vector3;
+        set authorCameraPosition(value: Common.Vector3);
+        get authorCameraRotation(): Common.Vector4;
+        set authorCameraRotation(value: Common.Vector4);
     }
 }
 export declare namespace Multiplayer {
@@ -4865,6 +4578,11 @@ export declare namespace Multiplayer {
          * @return True if there was an error, false otherwise.
          */
         hasError(): boolean;
+        /**
+         * @description Checks if the entity has a script component.
+         * @return True if component exist, false otherwise.
+         */
+        hasEntityScriptComponent(): boolean;
         /**
          * @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.
@@ -7526,7 +7244,7 @@ export declare namespace Multiplayer {
         @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: (result: Multiplayer.AnnotationThumbnailCollectionResult) => void): void;
+        getAnnotationThumbnailsForConversation(): Promise<Multiplayer.AnnotationThumbnailCollectionResult>;
         /**
          * @description Sets a callback for when the conversation is updated by another client.
          * @param callback - Callback to receive data for the conversation that has been changed.
@@ -9796,6 +9514,7 @@ export declare namespace Systems {
          * @return Const ref of asset collection class
          */
         getAssetCollection(): Systems.AssetCollection;
+        static create(): AssetCollectionResult;
         delete(): void;
     }
 }
@@ -11328,6 +11047,7 @@ export declare namespace Systems {
          * @return The space code
          */
         getSpaceCode(): string;
+        static create(): SpaceResult;
         delete(): void;
     }
 }
@@ -11541,7 +11261,7 @@ export declare namespace Systems {
          */
         updateSpace(spaceId: string, name: string | null, description: string | null, type: Systems.SpaceAttributes | null, tags: Common.Array<string> | null): Promise<Systems.BasicSpaceResult>;
         /**
-         * @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
          */