connected-spaces-platform.web 5.3.1 → 5.5.0

package/connectedspacesplatform.d.ts

@@ -202,7 +202,8 @@ export declare namespace Multiplayer {
         String = 4,
         Vector2 = 5,
         Vector3 = 6,
-        Vector4 = 7
+        Vector4 = 7,
+        Map = 8
     }
 }
 export declare namespace Multiplayer {
@@ -3775,20 +3776,6 @@ export declare namespace Multiplayer {
         set newKey(value: string);
     }
 }
-export declare namespace Multiplayer {
-    class SequenceHierarchyChangedParams extends NativeClassWrapper implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static create(): SequenceHierarchyChangedParams;
-        delete(): void;
-        get updateType(): Multiplayer.ESequenceUpdateType;
-        set updateType(value: Multiplayer.ESequenceUpdateType);
-        get parentId(): bigint;
-        set parentId(value: bigint);
-        get isRoot(): boolean;
-        set isRoot(value: boolean);
-    }
-}
 export declare namespace Multiplayer {
     class SequenceHotspotChangedParams extends NativeClassWrapper implements INativeResource {
         /** @internal */
@@ -3959,6 +3946,11 @@ export declare namespace Multiplayer {
          * @param inVector4Value - Initial value.
          */
         static create_vector4Value(vector4Value: Common.Vector4): ReplicatedValue;
+        /**
+         * @description Construct a ReplicatedValue based on an csp::common::Map type.
+         * @param inMapValue - Initial value.
+         */
+        static create_mapValue(mapValue: Common.Map<Multiplayer.ReplicatedValue, Multiplayer.ReplicatedValue>): ReplicatedValue;
         /**
          * @description Copy constructor
          * @param other - The value to copy.
@@ -3980,6 +3972,14 @@ export declare namespace Multiplayer {
          * @description Non equality operator overload.
          * @param replicatedValue - Other value to compare to.
          */
+        /**
+         * @description Less than operator overload.
+         * @param replicatedValue - Other value to compare to.
+         */
+        /**
+         * @description Greater than operator overload.
+         * @param replicatedValue - Other value to compare to.
+         */
         /**
          * @description Gets the type of replicated value.
          * @return Enum representing all supported replication base types.
@@ -4055,24 +4055,16 @@ export declare namespace Multiplayer {
          * /// @return csp::common::Vector4
          */
         getVector4(): Common.Vector4;
-    }
-}
-export declare namespace Multiplayer {
-    /**
-  @ingroup Space Entity System
-   * @description Class which exposes data that is relevent to entity hierarchies, which comes from the underlying Sequence System.
-   * This allows users to manage the ordering of child entites within their parent.
-   */
-    class SequenceHierarchy extends NativeClassWrapper implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        hasParent(): boolean;
-        static create(): SequenceHierarchy;
-        delete(): void;
-        get ids(): Common.Array<bigint>;
-        set ids(value: Common.Array<bigint>);
-        get parentId(): bigint;
-        set parentId(value: bigint);
+        /**
+         * @description Get a csp::common::Map value from this replicated value, will assert if not a csp::common::Map type.
+         * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
+         * /// @return csp::common::Map
+         */
+        getMap(): Common.Map<Multiplayer.ReplicatedValue, Multiplayer.ReplicatedValue>;
+        /**
+         * @description Set a Map value for this replicated value from a csp::common::Map, will overwrite and previous value.
+         */
+        setMap(value: Common.Map<Multiplayer.ReplicatedValue, Multiplayer.ReplicatedValue>): void;
     }
 }
 export declare namespace Multiplayer {
@@ -4594,43 +4586,6 @@ export declare namespace Multiplayer {
          * @return A list of root entities.
          */
         getRootHierarchyEntities(): Common.List<Multiplayer.SpaceEntity>;
-        /**
-         * @description Creates an entity hierarchy for a given parent entity id. Pass null to create a hiererchy for the root.
-         * @param parentId - An optional parent. Pass null to create a hiererchy for the root.
-         * @param hierarchyItemIds - An array of entity ids.
-         * @param callback - A callback when the asynchronous task finishes.
-         */
-        createSequenceHierarchy(parentId: bigint | null, hierarchyItemIds: Common.Array<bigint>): Promise<Multiplayer.SequenceHierarchyResult>;
-        /**
-         * @description Updates an entity hierarchy for a given parent entity id. Pass null to update the root.
-         * This will create a hierarchy if it doesnt exist.
-         * @param parentId - An optional parent. Pass null to create a hiererchy for the root.
-         * @param hierarchyItemIds - An array of entity ids.
-         * @param callback - A callback when the asynchronous task finishes.
-         */
-        updateSequenceHierarchy(parentId: bigint | null, hierarchyItemIds: Common.Array<bigint>): Promise<Multiplayer.SequenceHierarchyResult>;
-        /**
-         * @description Gets an entity hierarchy for a given parent entity id. Pass null to get the root hierarchy.
-         * @param parentId - An optional parent. Pass null to get the root hierarchy.
-         * @param callback - A callback when the asynchronous task finishes.
-         */
-        getSequenceHierarchy(parentId: bigint | null): Promise<Multiplayer.SequenceHierarchyResult>;
-        /**
-         * @description Gets all hierarchies for a space
-         * @param callback - A callback when the asynchronous task finishes.
-         */
-        getAllSequenceHierarchies(): Promise<Multiplayer.SequenceHierarchyCollectionResult>;
-        /**
-         * @description Deletes an entity hierarchy for a given parent entity id. Pass null to delete the root hierarchy.
-         * @param parentId - An optional parent. Pass null to get the root hierarchy.
-         * @param callback - A callback when the asynchronous task finishes.
-         */
-        deleteSequenceHierarchy(parentId: bigint | null): Promise<Systems.NullResult>;
-        /**
-         * @description Sets a callback for a sequence  hierarchy changed event.
-         * @param callback - Callback to receive data for the sequence hierarchy that has been changed.
-         */
-        setSequenceHierarchyChangedCallback(callback: (arg1: Multiplayer.SequenceHierarchyChangedParams) => void): void;
     }
 }
 export declare namespace Multiplayer {
@@ -6251,38 +6206,6 @@ export declare namespace Systems {
         isLocalUserMuted(): boolean;
     }
 }
-export declare namespace Multiplayer {
-    /**
-  @ingroup Space Entity System
-   * @description Data class used to contain information when attempting to get a sequence hierarchy
-   */
-    class SequenceHierarchyResult extends Systems.ResultBase implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static fromResultBase(baseInstance: Systems.ResultBase): Multiplayer.SequenceHierarchyResult;
-        /**
-         * @description Retreives the SequenceHierarchy from the result.
-         */
-        getSequenceHierarchy(): Multiplayer.SequenceHierarchy;
-        delete(): void;
-    }
-}
-export declare namespace Multiplayer {
-    /**
-  @ingroup Space Entity System
-   * @description Data class used to contain information when attempting to get an array of sequence hierachies
-   */
-    class SequenceHierarchyCollectionResult extends Systems.ResultBase implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static fromResultBase(baseInstance: Systems.ResultBase): Multiplayer.SequenceHierarchyCollectionResult;
-        /**
-         * @description Retreives the SequenceHierarchies from the result.
-         */
-        getSequenceHierarchyCollection(): Common.Array<Multiplayer.SequenceHierarchy>;
-        delete(): void;
-    }
-}
 export declare namespace Multiplayer {
     /**
   @ingroup AnimatedModelSpaceComponent
@@ -6920,7 +6843,7 @@ export declare namespace Multiplayer {
         static create_parent(parent: Multiplayer.SpaceEntity): CinematicCameraSpaceComponent;
         /**
          * @description Gived the sensor size and focal length, return the horizonal fov
-         * @return FOV in degrees
+         * @return FOV in radians
          */
         getFov(): number;
         /**
@@ -9467,9 +9390,10 @@ export declare namespace Systems {
          * @description Updates the Metadata field of an Asset Collection
          * @param assetCollection - Asset collection to be updated
          * @param newMetadata - The new metadata information that will replace the previous
+         * @param tags - Optional array of strings to replace the tags
          * @param callback - Callback when asynchronous task finishes
          */
-        updateAssetCollectionMetadata(assetCollection: Systems.AssetCollection, newMetadata: Common.Map<string, string>): Promise<Systems.AssetCollectionResult>;
+        updateAssetCollectionMetadata(assetCollection: Systems.AssetCollection, newMetadata: Common.Map<string, string>, tags: Common.Array<string> | null): Promise<Systems.AssetCollectionResult>;
         /**
          * @description Creates a new asset.
          * @param assetCollection - The parent collection for the asset to be associated with
@@ -10877,9 +10801,10 @@ export declare namespace Systems {
          * their emails and roles
          * @param metadata - Metadata information for the new space
          * @param fileThumbnail - Optional thumbnail image for the new space
+         * @param tags - Optional array of strings to set the metadata tags for the new space
          * @param callback - Callback when asynchronous task finishes
          */
-        createSpace(name: string, description: string, attributes: Systems.SpaceAttributes, inviteUsers: Systems.InviteUserRoleInfoCollection | null, metadata: Common.Map<string, string>, fileThumbnail: Systems.FileAssetDataSource | null): Promise<Systems.SpaceResult>;
+        createSpace(name: string, description: string, attributes: Systems.SpaceAttributes, inviteUsers: Systems.InviteUserRoleInfoCollection | null, metadata: Common.Map<string, string>, fileThumbnail: Systems.FileAssetDataSource | null, tags: Common.Array<string> | null): Promise<Systems.SpaceResult>;
         /**
          * @description Creates a new space Using BufferAssetDataSource.
          * @param name - Name for the new space
@@ -10889,9 +10814,10 @@ export declare namespace Systems {
          * their emails and roles
          * @param metadata - Metadata information for the new space
          * @param thumbnail - Thumbnail image buffer for the new space
+         * @param tags - Optional array of strings to set the metadata tags for the new space
          * @param callback - Callback when asynchronous task finishes
          */
-        createSpaceWithBuffer(name: string, description: string, attributes: Systems.SpaceAttributes, inviteUsers: Systems.InviteUserRoleInfoCollection | null, metadata: Common.Map<string, string>, thumbnail: Systems.BufferAssetDataSource): Promise<Systems.SpaceResult>;
+        createSpaceWithBuffer(name: string, description: string, attributes: Systems.SpaceAttributes, inviteUsers: Systems.InviteUserRoleInfoCollection | null, metadata: Common.Map<string, string>, thumbnail: Systems.BufferAssetDataSource, tags: Common.Array<string> | null): Promise<Systems.SpaceResult>;
         /**
          * @description Updates the name and/or the description of a Space
          * @param space - The space to update
@@ -11019,9 +10945,10 @@ export declare namespace Systems {
          * @description Updates the Space metadata information with the new one provided
          * @param spaceId - ID of Space for which the metadata will be updated
          * @param newMetadata - New metadata information that will replace the previous one
+         * @param tags - Optional array of strings to replace the tags in the metadata
          * @param callback - Callback when asynchronous task finishes
          */
-        updateSpaceMetadata(spaceId: string, newMetadata: Common.Map<string, string>): Promise<Systems.NullResult>;
+        updateSpaceMetadata(spaceId: string, newMetadata: Common.Map<string, string>, tags: Common.Array<string> | null): Promise<Systems.NullResult>;
         /**
          * @description Retrieves Spaces metadata information
          * @param spaces - Spaces for which metadata will be retrieved
@@ -11622,8 +11549,6 @@ export declare namespace Common {
         static ofcsp_multiplayer_ReplicatedValue(): Array<Multiplayer.ReplicatedValue>;
         static ofcsp_multiplayer_ComponentUpdateInfo(): Array<Multiplayer.ComponentUpdateInfo>;
         static ofcsp_systems_SpaceUserRole(): Array<Systems.SpaceUserRole>;
-        static ofuint64_t(): Array<bigint>;
-        static ofcsp_multiplayer_SequenceHierarchy(): Array<Multiplayer.SequenceHierarchy>;
         static ofcsp_multiplayer_MessageInfo(): Array<Multiplayer.MessageInfo>;
         static ofString(): Array<string>;
         static ofcsp_systems_EAssetPlatform(): Array<Systems.EAssetPlatform>;
@@ -11666,8 +11591,6 @@ export declare namespace Common {
         static ofcsp_multiplayer_ReplicatedValue_number(size: number): Array<Multiplayer.ReplicatedValue>;
         static ofcsp_multiplayer_ComponentUpdateInfo_number(size: number): Array<Multiplayer.ComponentUpdateInfo>;
         static ofcsp_systems_SpaceUserRole_number(size: number): Array<Systems.SpaceUserRole>;
-        static ofuint64_t_number(size: number): Array<bigint>;
-        static ofcsp_multiplayer_SequenceHierarchy_number(size: number): Array<Multiplayer.SequenceHierarchy>;
         static ofcsp_multiplayer_MessageInfo_number(size: number): Array<Multiplayer.MessageInfo>;
         static ofString_number(size: number): Array<string>;
         static ofcsp_systems_EAssetPlatform_number(size: number): Array<Systems.EAssetPlatform>;
@@ -11750,10 +11673,12 @@ export declare namespace Common {
         private TValueTypeFactory;
         private TValueTypeName;
         static ofUInt32Andcsp_multiplayer_ReplicatedValue(): Map<number, Multiplayer.ReplicatedValue>;
+        static ofcsp_multiplayer_ReplicatedValueAndcsp_multiplayer_ReplicatedValue(): Map<Multiplayer.ReplicatedValue, Multiplayer.ReplicatedValue>;
         static ofUInt16Andcsp_multiplayer_ComponentBase(): Map<number, Multiplayer.ComponentBase>;
         static ofStringAndString(): Map<string, string>;
         static ofStringAndcsp_common_Map_String_String(): Map<string, Common.Map<string, string>>;
         static ofUInt32Andcsp_multiplayer_ReplicatedValue_Map(other: Common.Map<number, Multiplayer.ReplicatedValue>): Map<number, Multiplayer.ReplicatedValue>;
+        static ofcsp_multiplayer_ReplicatedValueAndcsp_multiplayer_ReplicatedValue_Map(other: Common.Map<Multiplayer.ReplicatedValue, Multiplayer.ReplicatedValue>): Map<Multiplayer.ReplicatedValue, Multiplayer.ReplicatedValue>;
         static ofUInt16Andcsp_multiplayer_ComponentBase_Map(other: Common.Map<number, Multiplayer.ComponentBase>): Map<number, Multiplayer.ComponentBase>;
         static ofStringAndString_Map(other: Common.Map<string, string>): Map<string, string>;
         static ofStringAndcsp_common_Map_String_String_Map(other: Common.Map<string, Common.Map<string, string>>): Map<string, Common.Map<string, string>>;