connected-spaces-platform.web 5.1.0 → 5.3.1

package/connectedspacesplatform.d.ts

@@ -130,7 +130,8 @@ export declare namespace Multiplayer {
         FiducialMarker = 23,
         GaussianSplat = 24,
         Text = 25,
-        Hotspot = 26
+        Hotspot = 26,
+        CinematicCamera = 27
     }
 }
 export declare namespace Multiplayer {
@@ -162,7 +163,8 @@ export declare namespace Multiplayer {
         Create = 0,
         Update = 1,
         Rename = 2,
-        Delete = 3
+        Delete = 3,
+        Invalid = 4
     }
 }
 export declare namespace Multiplayer {
@@ -198,8 +200,9 @@ export declare namespace Multiplayer {
         Integer = 2,
         Float = 3,
         String = 4,
-        Vector3 = 5,
-        Vector4 = 6
+        Vector2 = 5,
+        Vector3 = 6,
+        Vector4 = 7
     }
 }
 export declare namespace Multiplayer {
@@ -405,6 +408,27 @@ export declare namespace Multiplayer {
         Num = 10
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Enumerates the list of properties that can be replicated for a CinematicCamera component.
+     */
+    enum CinematicCameraPropertyKeys {
+        Position = 0,
+        Rotation = 1,
+        IsEnabled = 2,
+        FocalLength = 3,
+        AspectRatio = 4,
+        SensorSize = 5,
+        NearClip = 6,
+        FarClip = 7,
+        Iso = 8,
+        ShutterSpeed = 9,
+        Aperture = 10,
+        IsViewerCamera = 11,
+        ThirdPartyComponentRef = 12,
+        Num = 13
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Enumerates the list of properties that can be replicated for a collision component.
@@ -1196,6 +1220,11 @@ export declare namespace Multiplayer {
          * @param value - The value to write.
          */
         writeString: (value: string) => void;
+        /**
+         * @description Write a vector2 field of the entity.
+         * @param value - The value to write.
+         */
+        writeVector2: (value: Common.Vector2) => void;
         /**
          * @description Write a vector3 field of the entity.
          * @param value - The value to write.
@@ -1297,6 +1326,11 @@ export declare namespace Multiplayer {
          * @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.
@@ -3432,6 +3466,60 @@ export declare namespace Common {
         getVector4(): Common.Vector4;
     }
 }
+export declare namespace Common {
+    /**
+     * @description Represents a 2 dimensional vector.
+     */
+    class Vector2 extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        /**
+         * @description Returns a Vector2 with all fields set to 0.
+         * @return Const vector2&
+         */
+        static zero(): Common.Vector2;
+        /**
+         * @description Returns a Vector2 with all fields set to 1.
+         * @return Const vector2&
+         */
+        static one(): Common.Vector2;
+        /**
+         * @description Constructs a Vector2 with all fields set to 0.
+         */
+        static create(): Vector2;
+        /**
+         * @description Constructs a Vector2 with the given x, y values.
+         * @param x - Float
+         * @param y - Float
+         */
+        static create_x_y(x: number, y: number): Vector2;
+        /**
+         * @description Member by member addition with another Vector2
+         * @param vector2 - Other
+         */
+        /**
+         * @description Subtracts another Vector2 from this one
+         * @param vector2 - Other
+         */
+        /**
+         * @description Divides the Vector2 by divisor
+         * @param float - Divisor
+         */
+        /**
+         * @description Member by member multiplication with another Vector2
+         * @param vector2 - Other
+         */
+        /**
+         * @description Multiplies the Vector2 by a scalar
+         * @param float - Scalar
+         */
+        delete(): void;
+        get x(): number;
+        set x(value: number);
+        get y(): number;
+        set y(value: number);
+    }
+}
 export declare namespace Common {
     /**
      * @description Represents a 3 dimensional vector.
@@ -3701,6 +3789,22 @@ export declare namespace Multiplayer {
         set isRoot(value: boolean);
     }
 }
+export declare namespace Multiplayer {
+    class SequenceHotspotChangedParams extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): SequenceHotspotChangedParams;
+        delete(): void;
+        get updateType(): Multiplayer.ESequenceUpdateType;
+        set updateType(value: Multiplayer.ESequenceUpdateType);
+        get spaceId(): string;
+        set spaceId(value: string);
+        get name(): string;
+        set name(value: string);
+        get newName(): string;
+        set newName(value: string);
+    }
+}
 export declare namespace Multiplayer {
     /**
   @ingroup Multiplayer
@@ -3761,6 +3865,11 @@ export declare namespace Multiplayer {
          * @param callback - Callback to receive data for the sequence that has been changed.
          */
         setSequenceChangedCallback(callback: (arg1: Multiplayer.SequenceChangedParams) => void): void;
+        /**
+         * @description Sets a callback to be fired when a hotspot sequence is changed.
+         * @param callback - Callback to receive data for the hotspot sequence that has been changed.
+         */
+        setHotspotSequenceChangedCallback(callback: (arg1: Multiplayer.SequenceHotspotChangedParams) => void): void;
         /**
          * @description Registers a callback to listen for the named event.
          * @param eventName - The identifying name for the event to listen for.
@@ -3835,6 +3944,11 @@ export declare namespace Multiplayer {
          * @param inStringValue - Initial value.
          */
         static create_stringValue(stringValue: string): ReplicatedValue;
+        /**
+         * @description Construct a ReplicatedValue based on a csp::common::Vector2 type.
+         * @param inVector2Value - Initial value.
+         */
+        static create_vector2Value(vector2Value: Common.Vector2): ReplicatedValue;
         /**
          * @description Construct a ReplicatedValue based on a csp::common::Vector3 type.
          * @param inVector3Value - Initial value.
@@ -3911,6 +4025,16 @@ export declare namespace Multiplayer {
          * /// @return csp::common::String&
          */
         getString(): string;
+        /**
+         * @description Set a Vector2 value for this replicated value from a csp::common::Vector2, will overwrite and previous value.
+         */
+        setVector2(value: Common.Vector2): void;
+        /**
+         * @description Get a csp::common::Vector2 value from this replicated value, will assert if not a csp::common::Vector2 type.
+         * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
+         * /// @return csp::common::Vector2
+         */
+        getVector2(): Common.Vector2;
         /**
          * @description Set a Vector3 value for this replicated value from a csp::common::Vector3, will overwrite and previous value.
          */
@@ -6041,7 +6165,7 @@ export declare namespace Systems {
 }
 export declare namespace Systems {
     /**
-     * @description Data structure for an Agora user token, giving userID, channel name and settings regarding sharing of audio/video/screenshare.
+     * @description Data structure for an Agora user token, giving userID, referenceID, channel name and settings regarding sharing of audio/video/screenshare.
      */
     class AgoraUserTokenParams extends NativeClassWrapper implements INativeResource {
         /** @internal */
@@ -6052,6 +6176,8 @@ export declare namespace Systems {
         set agoraUserId(value: string);
         get channelName(): string;
         set channelName(value: string);
+        get referenceId(): string;
+        set referenceId(value: string);
         get lifespan(): number;
         set lifespan(value: number);
         get readOnly(): boolean;
@@ -6778,6 +6904,173 @@ export declare namespace Multiplayer {
         delete(): void;
     }
 }
+export declare namespace Multiplayer {
+    /**
+  @ingroup CinematicCameraSpaceComponent
+   * @description Data representation of an CinematicCameraSpaceComponent.
+   */
+    class CinematicCameraSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IThirdPartyComponentRef, Multiplayer.IPositionComponent, Multiplayer.IRotationComponent, Multiplayer.IEnableableComponent, INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.CinematicCameraSpaceComponent;
+        /**
+         * @description Constructs the CinematicCamera space component, and associates it with the specified Parent space entity.
+         * @param parent - The Space entity that owns this component.
+         */
+        static create_parent(parent: Multiplayer.SpaceEntity): CinematicCameraSpaceComponent;
+        /**
+         * @description Gived the sensor size and focal length, return the horizonal fov
+         * @return FOV in degrees
+         */
+        getFov(): number;
+        /**
+         * \addtogroup IPositionComponent
+        @{
+        @copydoc IPositionComponent::GetPosition()
+         */
+        getPosition(): Common.Vector3;
+        /**
+        @copydoc IPositionComponent::SetPosition()
+         */
+        setPosition(value: Common.Vector3): void;
+        /**
+        @}
+         * \addtogroup IRotationComponent
+        @{
+        @copydoc IRotationComponent::GetRotation()
+         */
+        getRotation(): Common.Vector4;
+        /**
+        @copydoc IRotationComponent::SetRotation()
+         */
+        setRotation(value: Common.Vector4): void;
+        /**
+        @}
+         * @description Get focal length
+         * @return Current focal length
+         */
+        getFocalLength(): number;
+        /**
+         * @description Set focalLength
+         * Note: Effects the result of GetFov()
+         * @param value - Focallength
+         */
+        setFocalLength(value: number): void;
+        /**
+         * @description Get Current aspect ratio
+         * @return Current aspect ratio
+         */
+        getAspectRatio(): number;
+        /**
+         * @description Set Current aspect ratio
+         * @param value - Current aspect ratio
+         */
+        setAspectRatio(value: number): void;
+        /**
+         * @description Get sensor size
+         * @return Current sensor size
+         */
+        getSensorSize(): Common.Vector2;
+        /**
+         * @description Set Current SensorSize
+         * @param value - Current SensorSize
+         */
+        setSensorSize(value: Common.Vector2): void;
+        /**
+         * @description Get near clip
+         * Note: On platforms that don't support reversedZ, near clip should be used to control the clipping distance
+         * @return Current near clip
+         */
+        getNearClip(): number;
+        /**
+         * @description Set near clip
+         * @param value - Near clip
+         */
+        setNearClip(value: number): void;
+        /**
+         * @description Get far clip
+         * Note: On platforms that don't support reversedZ, far clip should be used to control the clipping distance
+         * @return Current far clip
+         */
+        getFarClip(): number;
+        /**
+         * @description Set far clip
+         * Note: far clip, controls how the density increases and height decreases. Smaller values make the visible transition larger.
+         * @param value - Far clip
+         */
+        setFarClip(value: number): void;
+        /**
+         * @description Get ISO sensitivity for controlling exposure.
+         * Note: reserved for future use, do not implement on clients
+         * @return Current iso
+         */
+        getIso(): number;
+        /**
+         * @description Set ISO sensitivity for controlling exposure.
+         * Note: reserved for future use, do not implement on clients
+         * @param value - ISO sensitivity for controlling exposure.
+         */
+        setIso(value: number): void;
+        /**
+         * @description Get shutter speed.
+         * Note: reserved for future use, do not implement on clients
+         * @param value - Shutter speed
+         */
+        getShutterSpeed(): number;
+        /**
+         * @description Set shutter speed
+         * Note: reserved for future use, do not implement on clients
+         * @param value - Shutter speed
+         */
+        setShutterSpeed(value: number): void;
+        /**
+         * @description Get aperture.
+         * Note: reserved for future use, do not implement on clients
+         * @param value - Aperture
+         */
+        getAperture(): number;
+        /**
+         * @description Set aperture
+         * Note: reserved for future use, do not implement on clients
+         * @param value - Aperture flag
+         */
+        setAperture(value: number): void;
+        /**
+         * @description Get IsViewerCamera.
+         * Note: reserved for future use, do not implement on clients
+         * @param value - IsViewerCamera
+         */
+        getIsViewerCamera(): boolean;
+        /**
+         * @description Set IsViewerCamera
+         * Note: reserved for future use, do not implement on clients
+         * @param value - IsViewerCamera Flag
+         */
+        setIsViewerCamera(value: boolean): void;
+        /**
+         * \addtogroup IEnableableComponent
+        @{
+        @copydoc IEnableableComponent::GetIsEnabled()
+         */
+        getIsEnabled(): boolean;
+        /**
+        @copydoc IEnableableComponent::SetIsEnabled()
+         */
+        setIsEnabled(value: boolean): void;
+        /**
+        @}
+         * \addtogroup IThirdPartyComponentRef
+        @{
+        @copydoc IThirdPartyComponentRef::GetThirdPartyComponentRef()
+         */
+        getThirdPartyComponentRef(): string;
+        /**
+        @copydoc IThirdPartyComponentRef::SetThirdPartyComponentRef()
+         */
+        setThirdPartyComponentRef(value: string): void;
+        delete(): void;
+    }
+}
 export declare namespace Multiplayer {
     /**
   @ingroup CollisionSpaceComponent
@@ -9749,6 +10042,13 @@ export declare namespace Systems {
          */
         deleteHotspotGroup(groupName: string): Promise<Systems.NullResult>;
         delete(): void;
+        /**
+         * @description This will delete any groups which only contain this item
+         * For any groups which contanin the given item and additional items, it will just update the group by removing the given item.
+         * @param itemName - An item to update all sequences containing.
+         * @param callback - Callback to call when a response is received
+         */
+        removeItemFromGroups(itemName: string): Promise<Systems.NullResult>;
     }
 }
 export declare namespace Systems {
@@ -10164,6 +10464,14 @@ export declare namespace Systems {
          * @param callback - Callback to call when a response is received
          */
         getSequencesByCriteria(sequenceKeys: Common.Array<string>, keyRegex: string | null, referenceType: string | null, referenceIds: Common.Array<string>, metaData: Common.Map<string, string>): Promise<Systems.SequencesResult>;
+        /**
+         * @description Finds all sequences that contain the given items
+         * @param items - An array of items which should be searched for
+         * @param referenceType - The type of reference (GroupId etc.). Must be used with ReferenceIds
+         * @param referenceIds - The ids of the reference. Must be used with ReferenceType
+         * @param callback - Callback to call when a response is received
+         */
+        getAllSequencesContainingItems(items: Common.Array<string>, referenceType: string | null, referenceIds: Common.Array<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 '%'