connected-spaces-platform.web 5.5.1 → 5.5.2

package/connectedspacesplatform.d.ts

@@ -6211,7 +6211,9 @@ export declare namespace Systems {
 export declare namespace Multiplayer {
     /**
   @ingroup AnimatedModelSpaceComponent
-   * @description Data representation of an AnimatedModelSpaceComponent.
+   * @description Adds animated skeletal meshes to a SpaceEntity.
+   * /// These are used for objects that need to move or act within the space, such as characters or animated props.
+   * This component makes it possible to play, pause, or loop animations.
    */
     class AnimatedModelSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, Multiplayer.IExternalResourceComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.IShadowCasterComponent, INativeResource {
         /** @internal */
@@ -6352,7 +6354,9 @@ export declare namespace Multiplayer {
 }
 export declare namespace Multiplayer {
     /**
-     * @description Data representation of an AudioSpaceComponent.
+     * @description Adds spatial audio to a SpaceEntity.
+     * /// This component creates immersive soundscapes by playing audio that reacts to the user's position in the space.
+     * Whether it's background music, sound effects, or voiceovers, the AudioSpaceComponent makes sound more engaging by positioning it in 3D space.
      */
     class AudioSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.IPositionComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
         /** @internal */
@@ -6717,7 +6721,7 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup ButtonSpaceComponent
-   * @description Data representation of an ButtonSpaceComponent.
+   * @description Add a clickable button to your space. Button click events can be responded to via scripts.
    */
     class ButtonSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
         /** @internal */
@@ -6999,7 +7003,8 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup CollisionSpaceComponent
-   * @description Data representation of an CollisionSpaceComponent.
+   * @description Add box, mesh, capsule and sphere colliders to objects in your Space.
+   * /// These colliders can act as triggers, which can be used in conjunction with Scripts to drive behavior.
    */
     class CollisionSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, INativeResource {
         /** @internal */
@@ -7138,7 +7143,7 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup ConversationSpaceComponent
-   * @description Data representation of an ConversationSpaceComponent.
+   * @description Add a conversation with comment thread to your space. These conversations have a spatial representation.
    */
     class ConversationSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, Multiplayer.IRotationComponent, INativeResource {
         /** @internal */
@@ -7275,7 +7280,7 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup CustomSpaceComponent
-   * @description Data representation of an CustomSpaceComponent.
+   * @description Can be used to prototype new component types or to support the replication of custom data.
    * NOTE: This class is used to replicate properties of primitive types of properties across multiple platforms.
    * The supported primitive types are the ones supported by the "ReplicatedValue" class.
    */
@@ -7342,7 +7347,8 @@ export declare namespace Multiplayer {
 }
 export declare namespace Multiplayer {
     /**
-     * @description Data representation of an ECommerceSpaceComponent.
+     * @description Can be used alongside CSP's Stripe integration to add e-commerce to your space.
+     * /// This component is used to represent physical objects that can be purchased as virtual items in the environment.
      */
     class ECommerceSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, INativeResource {
         /** @internal */
@@ -7380,8 +7386,7 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup ExternalLinkSpaceComponent
-   * @description Data representation of an ExternalLinkSpaceComponent.
-   * NOTE: This component can be used to handle external URLs that can be opened in game from a space.
+   * @description Used to handle external URLs that can be opened from within a space.
    */
     class ExternalLinkSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
         /** @internal */
@@ -7495,7 +7500,7 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup FiducialMarkerSpaceComponent
-   * @description Data representation of a FiducialMarkerSpaceComponent.
+   * @description As an alternative to cloud-based anchors, fiducial markers can be used to anchor your space to a physical location.
    */
     class FiducialMarkerSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
         /** @internal */
@@ -7603,7 +7608,7 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup FogSpaceComponent
-   * @description Data representation of an FogSpaceComponent.
+   * @description Add a depth-based fog volume to your space.
    */
     class FogSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
         /** @internal */
@@ -7779,7 +7784,7 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup GaussianSplatSpaceComponent
-   * @description Data representation of a GaussianSplatSpaceComponent.
+   * @description Add Gaussian Splats to your space.
    * Gaussian Splatting is a technique for real-time 3D reconstruction and rendering of an object or environment using images taken from multiple
    * points of view. Rather than representing the object as a mesh of triangles, which has a surface but nothing inside, it is instead represented as a
    * volume, comprising a point cloud of splats (like coloured dots), each of which has a position, colour (with alpha) and covariance (scale on 3
@@ -8001,7 +8006,7 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup ImageSpaceComponent
-   * @description Data representation of an ImageSpaceComponent.
+   * @description Add an image to your space.
    */
     class ImageSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
         /** @internal */
@@ -8139,7 +8144,8 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup LightSpaceComponent
-   * @description Data representation of an LightSpaceComponent.
+   * @description Adds various types of lighting to a SpaceEntity, such as directional, point, or spotlights.
+   * /// This component is essential for creating realistic lighting effects and controlling how objects are illuminated within the space.
    */
     class LightSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, Multiplayer.IRotationComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.IVisibleComponent, INativeResource {
         /** @internal */
@@ -8373,7 +8379,7 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup ReflectionSpaceComponent
-   * @description Data representation of an ReflectionSpaceComponent.
+   * @description Add sphere and box reflection captures to your Space which can be used by objects with reflective materials.
    */
     class ReflectionSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, Multiplayer.IScaleComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
         /** @internal */
@@ -8473,7 +8479,9 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup ScriptSpaceComponent
-   * @description Data representation of a ScriptSpaceComponent.
+   * @description Enables custom behavior through scripting.
+   * /// This component allows developers to author scripts that control how entities and components behave based on specific conditions or user actions.
+   * Scripts can modify entity properties, trigger events, or respond to user inputs.
    */
     class ScriptSpaceComponent extends Multiplayer.ComponentBase implements INativeResource {
         /** @internal */
@@ -8552,7 +8560,9 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup StaticModelSpaceComponent
-   * @description Data representation of an StaticModelSpaceComponent.
+   * @description Adds static 3D models to a SpaceEntity.
+   * /// It displays non-animated objects, such as furniture, buildings, or decorative items within a space.
+   * The static model defines the visual appearance but has no animations or dynamic behaviors.
    */
     class StaticModelSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IExternalResourceComponent, Multiplayer.IShadowCasterComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
         /** @internal */
@@ -8664,7 +8674,7 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup TextSpaceComponent
-   * @description Data representation of an TextSpaceComponent.
+   * @description Add a spatial representation of text to your space.
    */
     class TextSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
         /** @internal */
@@ -8804,7 +8814,9 @@ export declare namespace Multiplayer {
 export declare namespace Multiplayer {
     /**
   @ingroup VideoPlayerSpaceComponent
-   * @description Data representation of an VideoPlayerSpaceComponent.
+   * @description Enables the playback of video content within the space.
+   * /// You can use it to stream videos from a URL or play videos stored as assets in CSP, allowing users to watch videos directly within the virtual
+   * environment.
    */
     class VideoPlayerSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
         /** @internal */
@@ -10535,7 +10547,7 @@ export declare namespace Systems {
          * @description Retrieves the Avatar Portrait information associated with the space
          * If the user of the Avatar portrait associated with it the result callback will be successful, the HTTP res code will be ResponseNotFound
          * and the Uri field inside the UriResult will be empty
-         * @param inUserID - The id of the user we are seelomg to retrieve the portrait for
+         * @param inUserID - The id of the user we are seeking to retrieve the portrait for
          * @param callback - Callback when asynchronous task finishes
          */
         getAvatarPortrait(userID: string): Promise<Systems.UriResult>;
@@ -10548,10 +10560,10 @@ export declare namespace Systems {
         /**
          * @description Sets the avatar type and identifier for a user.
          * @param inType - The type of avatar (predefined, Ready Player Me, or custom).
-         * @param inIdentifier - A value used to identify or locate the avatar. Differs depending on the value of InType.
+         * @param inIdentifier - A string used to identify or locate the avatar.
          * @param callback - Callback to call when task finishes.
          */
-        setAvatarInfo(type: Systems.AvatarType, identifier: Common.Variant): Promise<Systems.NullResult>;
+        setAvatarInfo(type: Systems.AvatarType, identifier: string): Promise<Systems.NullResult>;
         /**
          * @description Retrieves the avatar type and identifier for a user.
          * @param callback - Callback to call when task finishes.

package/connectedspacesplatform.js

@@ -15268,7 +15268,9 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup AnimatedModelSpaceComponent
-   * @description Data representation of an AnimatedModelSpaceComponent.
+   * @description Adds animated skeletal meshes to a SpaceEntity.
+   * /// These are used for objects that need to move or act within the space, such as characters or animated props.
+   * This component makes it possible to play, pause, or loop animations.
    */
     class AnimatedModelSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -15513,7 +15515,9 @@ export class CSPFoundation {
 })(Multiplayer || (Multiplayer = {}));
 (function (Multiplayer) {
     /**
-     * @description Data representation of an AudioSpaceComponent.
+     * @description Adds spatial audio to a SpaceEntity.
+     * /// This component creates immersive soundscapes by playing audio that reacts to the user's position in the space.
+     * Whether it's background music, sound effects, or voiceovers, the AudioSpaceComponent makes sound more engaging by positioning it in 3D space.
      */
     class AudioSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -16088,7 +16092,7 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup ButtonSpaceComponent
-   * @description Data representation of an ButtonSpaceComponent.
+   * @description Add a clickable button to your space. Button click events can be responded to via scripts.
    */
     class ButtonSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -16567,7 +16571,8 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup CollisionSpaceComponent
-   * @description Data representation of an CollisionSpaceComponent.
+   * @description Add box, mesh, capsule and sphere colliders to objects in your Space.
+   * /// These colliders can act as triggers, which can be used in conjunction with Scripts to drive behavior.
    */
     class CollisionSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -16821,7 +16826,7 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup ConversationSpaceComponent
-   * @description Data representation of an ConversationSpaceComponent.
+   * @description Add a conversation with comment thread to your space. These conversations have a spatial representation.
    */
     class ConversationSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -17206,7 +17211,7 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup CustomSpaceComponent
-   * @description Data representation of an CustomSpaceComponent.
+   * @description Can be used to prototype new component types or to support the replication of custom data.
    * NOTE: This class is used to replicate properties of primitive types of properties across multiple platforms.
    * The supported primitive types are the ones supported by the "ReplicatedValue" class.
    */
@@ -17325,7 +17330,8 @@ export class CSPFoundation {
 })(Multiplayer || (Multiplayer = {}));
 (function (Multiplayer) {
     /**
-     * @description Data representation of an ECommerceSpaceComponent.
+     * @description Can be used alongside CSP's Stripe integration to add e-commerce to your space.
+     * /// This component is used to represent physical objects that can be purchased as virtual items in the environment.
      */
     class ECommerceSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -17395,8 +17401,7 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup ExternalLinkSpaceComponent
-   * @description Data representation of an ExternalLinkSpaceComponent.
-   * NOTE: This component can be used to handle external URLs that can be opened in game from a space.
+   * @description Used to handle external URLs that can be opened from within a space.
    */
     class ExternalLinkSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -17597,7 +17602,7 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup FiducialMarkerSpaceComponent
-   * @description Data representation of a FiducialMarkerSpaceComponent.
+   * @description As an alternative to cloud-based anchors, fiducial markers can be used to anchor your space to a physical location.
    */
     class FiducialMarkerSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -17787,7 +17792,7 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup FogSpaceComponent
-   * @description Data representation of an FogSpaceComponent.
+   * @description Add a depth-based fog volume to your space.
    */
     class FogSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -18082,7 +18087,7 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup GaussianSplatSpaceComponent
-   * @description Data representation of a GaussianSplatSpaceComponent.
+   * @description Add Gaussian Splats to your space.
    * Gaussian Splatting is a technique for real-time 3D reconstruction and rendering of an object or environment using images taken from multiple
    * points of view. Rather than representing the object as a mesh of triangles, which has a surface but nothing inside, it is instead represented as a
    * volume, comprising a point cloud of splats (like coloured dots), each of which has a position, colour (with alpha) and covariance (scale on 3
@@ -18457,7 +18462,7 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup ImageSpaceComponent
-   * @description Data representation of an ImageSpaceComponent.
+   * @description Add an image to your space.
    */
     class ImageSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -18692,7 +18697,8 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup LightSpaceComponent
-   * @description Data representation of an LightSpaceComponent.
+   * @description Adds various types of lighting to a SpaceEntity, such as directional, point, or spotlights.
+   * /// This component is essential for creating realistic lighting effects and controlling how objects are illuminated within the space.
    */
     class LightSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -19105,7 +19111,7 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup ReflectionSpaceComponent
-   * @description Data representation of an ReflectionSpaceComponent.
+   * @description Add sphere and box reflection captures to your Space which can be used by objects with reflective materials.
    */
     class ReflectionSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -19274,7 +19280,9 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup ScriptSpaceComponent
-   * @description Data representation of a ScriptSpaceComponent.
+   * @description Enables custom behavior through scripting.
+   * /// This component allows developers to author scripts that control how entities and components behave based on specific conditions or user actions.
+   * Scripts can modify entity properties, trigger events, or respond to user inputs.
    */
     class ScriptSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -19421,7 +19429,9 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup StaticModelSpaceComponent
-   * @description Data representation of an StaticModelSpaceComponent.
+   * @description Adds static 3D models to a SpaceEntity.
+   * /// It displays non-animated objects, such as furniture, buildings, or decorative items within a space.
+   * The static model defines the visual appearance but has no animations or dynamic behaviors.
    */
     class StaticModelSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -19620,7 +19630,7 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup TextSpaceComponent
-   * @description Data representation of an TextSpaceComponent.
+   * @description Add a spatial representation of text to your space.
    */
     class TextSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -19866,7 +19876,9 @@ export class CSPFoundation {
 (function (Multiplayer) {
     /**
   @ingroup VideoPlayerSpaceComponent
-   * @description Data representation of an VideoPlayerSpaceComponent.
+   * @description Enables the playback of video content within the space.
+   * /// You can use it to stream videos from a URL or play videos stored as assets in CSP, allowing users to watch videos directly within the virtual
+   * environment.
    */
     class VideoPlayerSpaceComponent extends Multiplayer.ComponentBase {
         /** @internal */
@@ -24491,7 +24503,7 @@ export class CSPFoundation {
          * @description Retrieves the Avatar Portrait information associated with the space
          * If the user of the Avatar portrait associated with it the result callback will be successful, the HTTP res code will be ResponseNotFound
          * and the Uri field inside the UriResult will be empty
-         * @param inUserID - The id of the user we are seelomg to retrieve the portrait for
+         * @param inUserID - The id of the user we are seeking to retrieve the portrait for
          * @param callback - Callback when asynchronous task finishes
          */
         async getAvatarPortrait(userID) {
@@ -24540,7 +24552,7 @@ export class CSPFoundation {
         /**
          * @description Sets the avatar type and identifier for a user.
          * @param inType - The type of avatar (predefined, Ready Player Me, or custom).
-         * @param inIdentifier - A value used to identify or locate the avatar. Differs depending on the value of InType.
+         * @param inIdentifier - A string used to identify or locate the avatar.
          * @param callback - Callback to call when task finishes.
          */
         async setAvatarInfo(type, identifier) {
@@ -24559,7 +24571,7 @@ export class CSPFoundation {
                 Module.removeFunction(_callbackPtr);
             };
             _callbackPtr = Module.addFunction(_callback, "vii");
-            Module.ccall("csp_systems_SettingsSystem_SetAvatarInfo_void_AvatarType_VariantRC_NullResultCallback", "void", ["number", "number", "number", "number", "number"], [this.pointer, type, identifier.pointer, _callbackPtr, 0]);
+            Module.ccall("csp_systems_SettingsSystem_SetAvatarInfo_void_AvatarType_StringRC_NullResultCallback", "void", ["number", "number", "string", "number", "number"], [this.pointer, type, identifier, _callbackPtr, 0]);
             return _promise;
         }
         /**