connected-spaces-platform.web 5.0.1 → 5.1.0

package/connectedspacesplatform.d.ts

@@ -161,7 +161,8 @@ export declare namespace Multiplayer {
     enum ESequenceUpdateType {
         Create = 0,
         Update = 1,
-        Delete = 2
+        Rename = 2,
+        Delete = 3
     }
 }
 export declare namespace Multiplayer {
@@ -242,7 +243,8 @@ export declare namespace Multiplayer {
         UPDATE_FLAGS_COMPONENTS = 16,
         UPDATE_FLAGS_SELECTION_ID = 32,
         UPDATE_FLAGS_THIRD_PARTY_REF = 64,
-        UPDATE_FLAGS_THIRD_PARTY_PLATFORM = 128
+        UPDATE_FLAGS_THIRD_PARTY_PLATFORM = 128,
+        UPDATE_FLAGS_PARENT = 256
     }
 }
 export declare namespace Multiplayer {
@@ -897,7 +899,8 @@ export declare namespace Systems {
         ShopifyConnectionBroken = 31,
         ShopifyInvalidStoreName = 32,
         UserShopifyLimitReached = 33,
-        UserTokenRefreshFailed = 34
+        UserTokenRefreshFailed = 34,
+        InvalidSequenceKey = 35
     }
 }
 export declare namespace Systems {
@@ -1309,6 +1312,11 @@ export declare namespace Multiplayer {
          * @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.
@@ -3452,6 +3460,26 @@ export declare namespace Common {
          * @param z - Float
          */
         static create_x_y_z(x: number, y: number, z: number): Vector3;
+        /**
+         * @description Member by member addition with another Vector3
+         * @param vector3 - Other
+         */
+        /**
+         * @description Subtracts another Vector3 from this one
+         * @param vector3 - Other
+         */
+        /**
+         * @description Divides the Vector3 by divisor
+         * @param float - Divisor
+         */
+        /**
+         * @description Member by member multiplication with another Vector3
+         * @param vector3 - Other
+         */
+        /**
+         * @description Multiplies the Vector3 by a scalar
+         * @param float - Scalar
+         */
         delete(): void;
         get x(): number;
         set x(value: number);
@@ -3495,6 +3523,26 @@ export declare namespace Common {
          * @param w - Float
          */
         static create_x_y_z_w(x: number, y: number, z: number, w: number): Vector4;
+        /**
+         * @description Member by member addition with another Vector4
+         * @param vector4 - Other
+         */
+        /**
+         * @description Subtracts another Vector4 from this one
+         * @param vector4 - Other
+         */
+        /**
+         * @description Divides the Vector4 by divisor
+         * @param float - Divisor
+         */
+        /**
+         * @description Member by member multiplication with another Vector4
+         * @param vector4 - Other
+         */
+        /**
+         * @description Multiplies the Vector4 by a scalar
+         * @param float - Scalar
+         */
         delete(): void;
         get x(): number;
         set x(value: number);
@@ -3639,6 +3687,20 @@ 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 {
     /**
   @ingroup Multiplayer
@@ -3871,6 +3933,24 @@ export declare namespace Multiplayer {
         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);
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Info class that specifies a type of update and the ID of a component the update is applied to.
@@ -3931,11 +4011,21 @@ export declare namespace Multiplayer {
          * @return SpaceTransform.
          */
         getTransform(): Multiplayer.SpaceTransform;
+        /**
+         * @description Get the Global SpaceTransform of the SpaceEntity, derived from it's parent.
+         * @return SpaceTransform.
+         */
+        getGlobalTransform(): Multiplayer.SpaceTransform;
         /**
          * @description Get the position of the SpaceEntity, in world space.
          * @return Position.
          */
         getPosition(): Common.Vector3;
+        /**
+         * @description Get the Global position of the SpaceEntity, in world space, derived from it's parent.
+         * @return Position.
+         */
+        getGlobalPosition(): Common.Vector3;
         /**
          * @description Set the position of the SpaceEntity, in world space.
          * @param value - The position to set.
@@ -3946,6 +4036,11 @@ export declare namespace Multiplayer {
          * @return Rotation.
          */
         getRotation(): Common.Vector4;
+        /**
+         * @description Get the Global rotation of the SpaceEntity, derived from it's parent.
+         * @return Rotation.
+         */
+        getGlobalRotation(): Common.Vector4;
         /**
          * @description Set the rotation of the SpaceEntity.
          * @param value - The rotation to set.
@@ -3956,6 +4051,11 @@ export declare namespace Multiplayer {
          * @return Scale.
          */
         getScale(): Common.Vector3;
+        /**
+         * @description Get the Global scale of the SpaceEntity, derived from it's parent.
+         * @return Scale.
+         */
+        getGlobalScale(): Common.Vector3;
         /**
          * @description Set the scale of the SpaceEntity.
          * @param value - The scale to set.
@@ -3996,6 +4096,35 @@ export declare namespace Multiplayer {
          * @return SpaceEntitySystem
          */
         getSpaceEntitySystem(): Multiplayer.SpaceEntitySystem;
+        /**
+         * @description Sets the parent for this entity
+         * QueueUpdate() should be called afterwards to enable changes to the parent.
+         * @param parentId - Uint64_t the new parent id of this entity.
+         */
+        setParentId(parentId: bigint): void;
+        /**
+         * @description Removes the parent entity
+         * QueueUpdate() should be called afterwards to enable changes to the parent.
+         */
+        removeParentEntity(): void;
+        /**
+         * @description Gets the parent of this entity
+         * @return SpaceEntity
+         */
+        getParentEntity(): Multiplayer.SpaceEntity;
+        /**
+         * @description Create a new entity with this entity as it's parent
+         * @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.
+         */
+        createChildEntity(name: string, spaceTransform: Multiplayer.SpaceTransform): Promise<Multiplayer.SpaceEntity>;
+        /**
+         * @description Gets the children of this entity
+         * @return Csp::common::list&lt;spaceentity&gt;
+         */
+        getChildEntities(): Common.List<Multiplayer.SpaceEntity>;
         /**
          * @description Queues an update which will be executed on next Tick() or ProcessPendingEntityOperations(). Not a blocking or async function.
          */
@@ -4336,6 +4465,48 @@ export declare namespace Multiplayer {
          * \endrst
          */
         setEntityPatchRateLimitEnabled(enabled: boolean): void;
+        /**
+         * @description Retrieves all entites that exist at the root level (do not have a parent entity).
+         * @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 {
@@ -4356,6 +4527,15 @@ export declare namespace Multiplayer {
          * @param scale - The scale value for the transform.
          */
         static create_position_rotation_scale(position: Common.Vector3, rotation: Common.Vector4, scale: Common.Vector3): SpaceTransform;
+        /**
+         * @description Equality operator
+         * @param spaceTransform - Transform
+         */
+        /**
+         * @description Multiplication operator
+         * @param spaceTransform - Transform
+         * NOTE: This mimics the operations of a matrix transform multiplication, but converts the back into a recognisable form.
+         */
         delete(): void;
         get position(): Common.Vector3;
         set position(value: Common.Vector3);
@@ -5945,6 +6125,38 @@ 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
@@ -9504,7 +9716,7 @@ export declare namespace Systems {
          * @param hotspotIds - Set of hotspot ids to add to the group
          * @param callback - Callback to call when a response is received
          */
-        createHotspotGroup(arg1: string, hotspotIds: Common.Array<string>): Promise<Systems.HotspotGroupResult>;
+        createHotspotGroup(groupName: string, hotspotIds: Common.Array<string>): Promise<Systems.HotspotGroupResult>;
         /**
          * @description Rename a Hotspot group
          * @param currentGroupName - The unique grouping name
@@ -9911,6 +10123,7 @@ export declare namespace Systems {
         static fromSystemBase(baseInstance: Systems.SystemBase): Systems.SequenceSystem;
         /**
          * @description Creates a new sequence. If a sequence already exists with this key, it will overwrite the current one.
+         * NOTE: This call will fail (Reason InvalidSequenceKey) if the SequenceKey parameter contains invalid keys, such as spaces, '/' or '%'
          * This call will fail if the user isn't a creator of the space.
          * @param sequenceKey - The unique grouping name. Our naming convention is: Type:[SpaceId]:[GroupName]
          * @param referenceType - The type of reference (GroupId etc.)
@@ -9922,6 +10135,7 @@ export declare namespace Systems {
         createSequence(sequenceKey: string, referenceType: string, referenceId: string, items: Common.Array<string>, metaData: Common.Map<string, string>): Promise<Systems.SequenceResult>;
         /**
          * @description Updates an existing sequence. This call will fail if the user isn't a creator of the space.
+         * NOTE: This call will fail if the SequenceKey parameter contains invalid keys, such as spaces, '/' or '%'
          * @param sequenceKey - The unique grouping name. Our naming convention is: Type:[SpaceId]:[GroupName]
          * @param referenceType - The type of reference (GroupId etc.)
          * @param referenceId - The id of the reference
@@ -9932,6 +10146,8 @@ export declare namespace Systems {
         updateSequence(sequenceKey: string, referenceType: string, referenceId: string, items: Common.Array<string>, metaData: Common.Map<string, string>): Promise<Systems.SequenceResult>;
         /**
          * @description Renames a given sequence. This call will fail if the user isn't a creator of the space.
+         * NOTE: This call will fail (Reason InvalidSequenceKey) if the OldSequenceKey, or NewSequenceKey parameters contains invalid keys, such as
+         * spaces, '/' or '%'
          * @param oldSequenceKey - The current sequence key name
          * @param newSequenceKey - The new sequence key name
          * @param callback - Callback to call when a response is received
@@ -9939,6 +10155,7 @@ export declare namespace Systems {
         renameSequence(oldSequenceKey: string, newSequenceKey: string): Promise<Systems.SequenceResult>;
         /**
          * @description Finds sequences based on the given criteria
+         * NOTE: This call will fail (Reason InvalidSequenceKey) if the SequenceKey parameter contains invalid keys, such as spaces, '/' or '%'
          * @param sequenceKeys - An array of sequence keys to search for
          * @param sequenceKeys - An optional regex string for searching keys
          * @param referenceType - The type of reference (GroupId etc.). Must be used with ReferenceIds
@@ -9949,12 +10166,14 @@ export declare namespace Systems {
         getSequencesByCriteria(sequenceKeys: Common.Array<string>, keyRegex: string | null, referenceType: string | null, referenceIds: Common.Array<string>, metaData: Common.Map<string, string>): Promise<Systems.SequencesResult>;
         /**
          * @description Gets a sequence by it's key
+         * NOTE: This call will fail (Reason InvalidSequenceKey) if the SequenceKey parameter contains invalid keys, such as spaces, '/' or '%'
          * @param sequenceKey - The unique grouping name
          * @param callback - Callback to call when a response is received
          */
         getSequence(sequenceKey: string): Promise<Systems.SequenceResult>;
         /**
          * @description Deletes the given sequences. This call will fail if the user isn't a creator of the space
+         * NOTE: This call will fail (Reason InvalidSequenceKey) if the SequenceKey parameter contains invalid keys, such as spaces, '/' or '%'
          * @param sequenceKeys - An array of sequence keys to delete
          * @param callback - Callback to call when a response is received
          */
@@ -10565,6 +10784,17 @@ export declare namespace Systems {
          * @param callback - Callback when asynchronous task finishes
          */
         deleteSpaceGeoLocation(spaceId: string): Promise<Systems.NullResult>;
+        /**
+         * @description Duplicate an existing space and assign it to the current user
+         * @param spaceId - Id of the space to duplicate.
+         * @param newName - A unique name for the duplicated space.
+         * @param newAttributes - Attributes to apply to the duplicated space.
+         * @param memberGroupIds - An optional array of group (space) IDs to copy users from.
+         * @param shallowCopy - If true, the duplicated space will reference the assets of the original space. Otherwise, all assets will be
+         * duplicated.
+         * @param callback - Callback when asynchronous task finishes
+         */
+        duplicateSpace(spaceId: string, newName: string, newAttributes: Systems.SpaceAttributes, memberGroupIds: Common.Array<string> | null, shallowCopy: boolean): Promise<Systems.SpaceResult>;
     }
 }
 export declare namespace Systems {
@@ -11084,6 +11314,8 @@ 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>;
@@ -11126,6 +11358,8 @@ 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>;
@@ -11178,10 +11412,13 @@ export declare namespace Common {
         constructor(pointer: NativePointer, TTypeFactory: ProxyClassFactory, TTypeName: string);
         private TTypeFactory;
         private TTypeName;
+        static ofcsp_multiplayer_SpaceEntity(): List<Multiplayer.SpaceEntity>;
         static ofString(): List<string>;
         static ofcsp_common_Vector3(): List<Common.Vector3>;
+        static ofcsp_multiplayer_SpaceEntity_number(minimumSize: number): List<Multiplayer.SpaceEntity>;
         static ofString_number(minimumSize: number): List<string>;
         static ofcsp_common_Vector3_number(minimumSize: number): List<Common.Vector3>;
+        static ofcsp_multiplayer_SpaceEntity_List(other: Common.List<Multiplayer.SpaceEntity>): List<Multiplayer.SpaceEntity>;
         static ofString_List(other: Common.List<string>): List<string>;
         static ofcsp_common_Vector3_List(other: Common.List<Common.Vector3>): List<Common.Vector3>;
         delete(): void;