connected-spaces-platform.web 5.5.0 → 5.5.2

package/connectedspacesplatform.ts

@@ -3101,17 +3101,19 @@ export namespace Multiplayer {
 export namespace Multiplayer {
   /**
    * @description Enum representing the type of a replicated value.
+   * These values are serialized and stored as integers.
+   * When adding new values, always add to the end
    */
   export enum ReplicatedValueType {
-    InvalidType,
-    Boolean,
-    Integer,
-    Float,
-    String,
-    Vector2,
-    Vector3,
-    Vector4,
-    Map,
+    InvalidType = 0,
+    Boolean = 1,
+    Integer = 2,
+    Float = 3,
+    String = 4,
+    Vector3 = 5,
+    Vector4 = 6,
+    Vector2 = 7,
+    Map = 8,
   }
 }
 
@@ -34052,7 +34054,9 @@ export namespace Systems {
 export 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.  
  */
   export class AnimatedModelSpaceComponent
     extends Multiplayer.ComponentBase
@@ -34535,7 +34539,9 @@ export namespace Multiplayer {
 
 export 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.
    */
   export class AudioSpaceComponent
     extends Multiplayer.ComponentBase
@@ -35581,7 +35587,7 @@ export namespace Multiplayer {
 export 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.  
  */
   export class ButtonSpaceComponent
     extends Multiplayer.ComponentBase
@@ -36497,7 +36503,8 @@ export namespace Multiplayer {
 export 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.  
  */
   export class CollisionSpaceComponent
     extends Multiplayer.ComponentBase
@@ -36981,7 +36988,7 @@ export namespace Multiplayer {
 export 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.  
  */
   export class ConversationSpaceComponent
     extends Multiplayer.ComponentBase
@@ -37674,7 +37681,7 @@ export namespace Multiplayer {
 export 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.  
  */
@@ -37898,7 +37905,8 @@ export namespace Multiplayer {
 
 export 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.
    */
   export class ECommerceSpaceComponent
     extends Multiplayer.ComponentBase
@@ -38028,8 +38036,7 @@ export namespace Multiplayer {
 export 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.  
  */
   export class ExternalLinkSpaceComponent
     extends Multiplayer.ComponentBase
@@ -38420,7 +38427,7 @@ export namespace Multiplayer {
 export 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.  
  */
   export class FiducialMarkerSpaceComponent
     extends Multiplayer.ComponentBase
@@ -38784,7 +38791,7 @@ export namespace Multiplayer {
 export namespace Multiplayer {
   /**
 @ingroup FogSpaceComponent
- * @description Data representation of an FogSpaceComponent.  
+ * @description Add a depth-based fog volume to your space.  
  */
   export class FogSpaceComponent
     extends Multiplayer.ComponentBase
@@ -39344,7 +39351,7 @@ export namespace Multiplayer {
 export 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  
@@ -40059,7 +40066,7 @@ export namespace Multiplayer {
 export namespace Multiplayer {
   /**
 @ingroup ImageSpaceComponent
- * @description Data representation of an ImageSpaceComponent.  
+ * @description Add an image to your space.  
  */
   export class ImageSpaceComponent
     extends Multiplayer.ComponentBase
@@ -40511,7 +40518,8 @@ export namespace Multiplayer {
 export 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.  
  */
   export class LightSpaceComponent
     extends Multiplayer.ComponentBase
@@ -41301,7 +41309,7 @@ export namespace Multiplayer {
 export 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.  
  */
   export class ReflectionSpaceComponent
     extends Multiplayer.ComponentBase
@@ -41616,7 +41624,9 @@ export namespace Multiplayer {
 export 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.  
  */
   export class ScriptSpaceComponent
     extends Multiplayer.ComponentBase
@@ -41893,7 +41903,9 @@ export namespace Multiplayer {
 export 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.  
  */
   export class StaticModelSpaceComponent
     extends Multiplayer.ComponentBase
@@ -42284,7 +42296,7 @@ export namespace Multiplayer {
 export namespace Multiplayer {
   /**
 @ingroup TextSpaceComponent
- * @description Data representation of an TextSpaceComponent.  
+ * @description Add a spatial representation of text to your space.  
  */
   export class TextSpaceComponent
     extends Multiplayer.ComponentBase
@@ -42762,7 +42774,9 @@ export namespace Multiplayer {
 export 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.  
  */
   export class VideoPlayerSpaceComponent
     extends Multiplayer.ComponentBase
@@ -50783,7 +50797,7 @@ export 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
      */
 
@@ -50864,13 +50878,13 @@ export 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.
      */
 
     async setAvatarInfo(
       type: Systems.AvatarType,
-      identifier: Common.Variant,
+      identifier: string,
     ): Promise<Systems.NullResult> {
       var _resolve;
 
@@ -50895,10 +50909,10 @@ export namespace Systems {
       _callbackPtr = Module.addFunction(_callback, "vii");
 
       Module.ccall(
-        "csp_systems_SettingsSystem_SetAvatarInfo_void_AvatarType_VariantRC_NullResultCallback",
+        "csp_systems_SettingsSystem_SetAvatarInfo_void_AvatarType_StringRC_NullResultCallback",
         "void",
-        ["number", "number", "number", "number", "number"],
-        [this.pointer, type, identifier.pointer, _callbackPtr, 0],
+        ["number", "number", "string", "number", "number"],
+        [this.pointer, type, identifier, _callbackPtr, 0],
       );
 
       return _promise;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "connected-spaces-platform.web",
   "displayName": "connected-spaces-platform.web",
-  "version": "5.5.0+553",
+  "version": "5.5.2+562",
   "description": "This package provides the binaries required to interface with the Connected Spaces Platform API.",
   "license": "Apache-2.0",
   "dependencies": {