connected-spaces-platform.web 5.5.1 → 5.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5050,26 +5050,6 @@ export declare namespace Systems {
5050
5050
  constructor(pointer: NativePointer);
5051
5051
  static create(): Asset;
5052
5052
  static create_other(other: Systems.Asset): Asset;
5053
- /**
5054
- * @description Gets the third party packaged asset identifier of this asset
5055
- * @return Returns a string representing the party packaged asset identifier set for this asset.
5056
- */
5057
- getThirdPartyPackagedAssetIdentifier(): string;
5058
- /**
5059
- * @description Sets the party packaged asset identifier for this asset
5060
- * @param inThirdPartyPackagedAssetIdentifier - The third party packaged asset identifier to set.
5061
- */
5062
- setThirdPartyPackagedAssetIdentifier(thirdPartyPackagedAssetIdentifier: string): void;
5063
- /**
5064
- * @description Gets the third party platform type of this asset
5065
- * @return Returns a string representing third party platform type set for this asset.
5066
- */
5067
- getThirdPartyPlatformType(): Systems.EThirdPartyPlatform;
5068
- /**
5069
- * @description Sets third party platform type for this asset
5070
- * @param inThirdPartyPlatformType - The third party platform type to set.
5071
- */
5072
- setThirdPartyPlatformType(thirdPartyPlatformType: Systems.EThirdPartyPlatform): void;
5073
5053
  delete(): void;
5074
5054
  get assetCollectionId(): string;
5075
5055
  set assetCollectionId(value: string);
@@ -5099,6 +5079,10 @@ export declare namespace Systems {
5099
5079
  set mimeType(value: string);
5100
5080
  get externalMimeType(): string;
5101
5081
  set externalMimeType(value: string);
5082
+ get thirdPartyPackagedAssetIdentifier(): string;
5083
+ set thirdPartyPackagedAssetIdentifier(value: string);
5084
+ get thirdPartyPlatformType(): Systems.EThirdPartyPlatform;
5085
+ set thirdPartyPlatformType(value: Systems.EThirdPartyPlatform);
5102
5086
  }
5103
5087
  }
5104
5088
  export declare namespace Systems {
@@ -6211,7 +6195,9 @@ export declare namespace Systems {
6211
6195
  export declare namespace Multiplayer {
6212
6196
  /**
6213
6197
  @ingroup AnimatedModelSpaceComponent
6214
- * @description Data representation of an AnimatedModelSpaceComponent.
6198
+ * @description Adds animated skeletal meshes to a SpaceEntity.
6199
+ * /// These are used for objects that need to move or act within the space, such as characters or animated props.
6200
+ * This component makes it possible to play, pause, or loop animations.
6215
6201
  */
6216
6202
  class AnimatedModelSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, Multiplayer.IExternalResourceComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.IShadowCasterComponent, INativeResource {
6217
6203
  /** @internal */
@@ -6352,7 +6338,9 @@ export declare namespace Multiplayer {
6352
6338
  }
6353
6339
  export declare namespace Multiplayer {
6354
6340
  /**
6355
- * @description Data representation of an AudioSpaceComponent.
6341
+ * @description Adds spatial audio to a SpaceEntity.
6342
+ * /// This component creates immersive soundscapes by playing audio that reacts to the user's position in the space.
6343
+ * Whether it's background music, sound effects, or voiceovers, the AudioSpaceComponent makes sound more engaging by positioning it in 3D space.
6356
6344
  */
6357
6345
  class AudioSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.IPositionComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
6358
6346
  /** @internal */
@@ -6717,7 +6705,7 @@ export declare namespace Multiplayer {
6717
6705
  export declare namespace Multiplayer {
6718
6706
  /**
6719
6707
  @ingroup ButtonSpaceComponent
6720
- * @description Data representation of an ButtonSpaceComponent.
6708
+ * @description Add a clickable button to your space. Button click events can be responded to via scripts.
6721
6709
  */
6722
6710
  class ButtonSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
6723
6711
  /** @internal */
@@ -6999,7 +6987,8 @@ export declare namespace Multiplayer {
6999
6987
  export declare namespace Multiplayer {
7000
6988
  /**
7001
6989
  @ingroup CollisionSpaceComponent
7002
- * @description Data representation of an CollisionSpaceComponent.
6990
+ * @description Add box, mesh, capsule and sphere colliders to objects in your Space.
6991
+ * /// These colliders can act as triggers, which can be used in conjunction with Scripts to drive behavior.
7003
6992
  */
7004
6993
  class CollisionSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, INativeResource {
7005
6994
  /** @internal */
@@ -7138,7 +7127,7 @@ export declare namespace Multiplayer {
7138
7127
  export declare namespace Multiplayer {
7139
7128
  /**
7140
7129
  @ingroup ConversationSpaceComponent
7141
- * @description Data representation of an ConversationSpaceComponent.
7130
+ * @description Add a conversation with comment thread to your space. These conversations have a spatial representation.
7142
7131
  */
7143
7132
  class ConversationSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, Multiplayer.IRotationComponent, INativeResource {
7144
7133
  /** @internal */
@@ -7275,7 +7264,7 @@ export declare namespace Multiplayer {
7275
7264
  export declare namespace Multiplayer {
7276
7265
  /**
7277
7266
  @ingroup CustomSpaceComponent
7278
- * @description Data representation of an CustomSpaceComponent.
7267
+ * @description Can be used to prototype new component types or to support the replication of custom data.
7279
7268
  * NOTE: This class is used to replicate properties of primitive types of properties across multiple platforms.
7280
7269
  * The supported primitive types are the ones supported by the "ReplicatedValue" class.
7281
7270
  */
@@ -7342,7 +7331,8 @@ export declare namespace Multiplayer {
7342
7331
  }
7343
7332
  export declare namespace Multiplayer {
7344
7333
  /**
7345
- * @description Data representation of an ECommerceSpaceComponent.
7334
+ * @description Can be used alongside CSP's Stripe integration to add e-commerce to your space.
7335
+ * /// This component is used to represent physical objects that can be purchased as virtual items in the environment.
7346
7336
  */
7347
7337
  class ECommerceSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, INativeResource {
7348
7338
  /** @internal */
@@ -7380,8 +7370,7 @@ export declare namespace Multiplayer {
7380
7370
  export declare namespace Multiplayer {
7381
7371
  /**
7382
7372
  @ingroup ExternalLinkSpaceComponent
7383
- * @description Data representation of an ExternalLinkSpaceComponent.
7384
- * NOTE: This component can be used to handle external URLs that can be opened in game from a space.
7373
+ * @description Used to handle external URLs that can be opened from within a space.
7385
7374
  */
7386
7375
  class ExternalLinkSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
7387
7376
  /** @internal */
@@ -7495,7 +7484,7 @@ export declare namespace Multiplayer {
7495
7484
  export declare namespace Multiplayer {
7496
7485
  /**
7497
7486
  @ingroup FiducialMarkerSpaceComponent
7498
- * @description Data representation of a FiducialMarkerSpaceComponent.
7487
+ * @description As an alternative to cloud-based anchors, fiducial markers can be used to anchor your space to a physical location.
7499
7488
  */
7500
7489
  class FiducialMarkerSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
7501
7490
  /** @internal */
@@ -7603,7 +7592,7 @@ export declare namespace Multiplayer {
7603
7592
  export declare namespace Multiplayer {
7604
7593
  /**
7605
7594
  @ingroup FogSpaceComponent
7606
- * @description Data representation of an FogSpaceComponent.
7595
+ * @description Add a depth-based fog volume to your space.
7607
7596
  */
7608
7597
  class FogSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
7609
7598
  /** @internal */
@@ -7779,7 +7768,7 @@ export declare namespace Multiplayer {
7779
7768
  export declare namespace Multiplayer {
7780
7769
  /**
7781
7770
  @ingroup GaussianSplatSpaceComponent
7782
- * @description Data representation of a GaussianSplatSpaceComponent.
7771
+ * @description Add Gaussian Splats to your space.
7783
7772
  * Gaussian Splatting is a technique for real-time 3D reconstruction and rendering of an object or environment using images taken from multiple
7784
7773
  * 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
7785
7774
  * 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 +7990,7 @@ export declare namespace Multiplayer {
8001
7990
  export declare namespace Multiplayer {
8002
7991
  /**
8003
7992
  @ingroup ImageSpaceComponent
8004
- * @description Data representation of an ImageSpaceComponent.
7993
+ * @description Add an image to your space.
8005
7994
  */
8006
7995
  class ImageSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
8007
7996
  /** @internal */
@@ -8139,7 +8128,8 @@ export declare namespace Multiplayer {
8139
8128
  export declare namespace Multiplayer {
8140
8129
  /**
8141
8130
  @ingroup LightSpaceComponent
8142
- * @description Data representation of an LightSpaceComponent.
8131
+ * @description Adds various types of lighting to a SpaceEntity, such as directional, point, or spotlights.
8132
+ * /// This component is essential for creating realistic lighting effects and controlling how objects are illuminated within the space.
8143
8133
  */
8144
8134
  class LightSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, Multiplayer.IRotationComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.IVisibleComponent, INativeResource {
8145
8135
  /** @internal */
@@ -8373,7 +8363,7 @@ export declare namespace Multiplayer {
8373
8363
  export declare namespace Multiplayer {
8374
8364
  /**
8375
8365
  @ingroup ReflectionSpaceComponent
8376
- * @description Data representation of an ReflectionSpaceComponent.
8366
+ * @description Add sphere and box reflection captures to your Space which can be used by objects with reflective materials.
8377
8367
  */
8378
8368
  class ReflectionSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, Multiplayer.IScaleComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
8379
8369
  /** @internal */
@@ -8473,7 +8463,9 @@ export declare namespace Multiplayer {
8473
8463
  export declare namespace Multiplayer {
8474
8464
  /**
8475
8465
  @ingroup ScriptSpaceComponent
8476
- * @description Data representation of a ScriptSpaceComponent.
8466
+ * @description Enables custom behavior through scripting.
8467
+ * /// This component allows developers to author scripts that control how entities and components behave based on specific conditions or user actions.
8468
+ * Scripts can modify entity properties, trigger events, or respond to user inputs.
8477
8469
  */
8478
8470
  class ScriptSpaceComponent extends Multiplayer.ComponentBase implements INativeResource {
8479
8471
  /** @internal */
@@ -8552,7 +8544,9 @@ export declare namespace Multiplayer {
8552
8544
  export declare namespace Multiplayer {
8553
8545
  /**
8554
8546
  @ingroup StaticModelSpaceComponent
8555
- * @description Data representation of an StaticModelSpaceComponent.
8547
+ * @description Adds static 3D models to a SpaceEntity.
8548
+ * /// It displays non-animated objects, such as furniture, buildings, or decorative items within a space.
8549
+ * The static model defines the visual appearance but has no animations or dynamic behaviors.
8556
8550
  */
8557
8551
  class StaticModelSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IExternalResourceComponent, Multiplayer.IShadowCasterComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
8558
8552
  /** @internal */
@@ -8664,7 +8658,7 @@ export declare namespace Multiplayer {
8664
8658
  export declare namespace Multiplayer {
8665
8659
  /**
8666
8660
  @ingroup TextSpaceComponent
8667
- * @description Data representation of an TextSpaceComponent.
8661
+ * @description Add a spatial representation of text to your space.
8668
8662
  */
8669
8663
  class TextSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
8670
8664
  /** @internal */
@@ -8804,7 +8798,9 @@ export declare namespace Multiplayer {
8804
8798
  export declare namespace Multiplayer {
8805
8799
  /**
8806
8800
  @ingroup VideoPlayerSpaceComponent
8807
- * @description Data representation of an VideoPlayerSpaceComponent.
8801
+ * @description Enables the playback of video content within the space.
8802
+ * /// 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
8803
+ * environment.
8808
8804
  */
8809
8805
  class VideoPlayerSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
8810
8806
  /** @internal */
@@ -10443,7 +10439,7 @@ export declare namespace Systems {
10443
10439
  * @description A getter which returns the String passed via the result.
10444
10440
  */
10445
10441
  getAvatarType(): Systems.AvatarType;
10446
- getAvatarIdentifier(): Common.Variant;
10442
+ getAvatarIdentifier(): string;
10447
10443
  delete(): void;
10448
10444
  }
10449
10445
  }
@@ -10535,7 +10531,7 @@ export declare namespace Systems {
10535
10531
  * @description Retrieves the Avatar Portrait information associated with the space
10536
10532
  * If the user of the Avatar portrait associated with it the result callback will be successful, the HTTP res code will be ResponseNotFound
10537
10533
  * and the Uri field inside the UriResult will be empty
10538
- * @param inUserID - The id of the user we are seelomg to retrieve the portrait for
10534
+ * @param inUserID - The id of the user we are seeking to retrieve the portrait for
10539
10535
  * @param callback - Callback when asynchronous task finishes
10540
10536
  */
10541
10537
  getAvatarPortrait(userID: string): Promise<Systems.UriResult>;
@@ -10548,10 +10544,10 @@ export declare namespace Systems {
10548
10544
  /**
10549
10545
  * @description Sets the avatar type and identifier for a user.
10550
10546
  * @param inType - The type of avatar (predefined, Ready Player Me, or custom).
10551
- * @param inIdentifier - A value used to identify or locate the avatar. Differs depending on the value of InType.
10547
+ * @param inIdentifier - A string used to identify or locate the avatar.
10552
10548
  * @param callback - Callback to call when task finishes.
10553
10549
  */
10554
- setAvatarInfo(type: Systems.AvatarType, identifier: Common.Variant): Promise<Systems.NullResult>;
10550
+ setAvatarInfo(type: Systems.AvatarType, identifier: string): Promise<Systems.NullResult>;
10555
10551
  /**
10556
10552
  * @description Retrieves the avatar type and identifier for a user.
10557
10553
  * @param callback - Callback to call when task finishes.
@@ -12177,39 +12177,6 @@ export class CSPFoundation {
12177
12177
  var _nPtr = getNativePointer(_ptr);
12178
12178
  return new Asset(_nPtr);
12179
12179
  }
12180
- /**
12181
- * @description Gets the third party packaged asset identifier of this asset
12182
- * @return Returns a string representing the party packaged asset identifier set for this asset.
12183
- */
12184
- getThirdPartyPackagedAssetIdentifier() {
12185
- let _result = Module.ccall("csp_systems_Asset_GetThirdPartyPackagedAssetIdentifierC_StringRC", "number", ["number"], [this.pointer]);
12186
- const _resultString = Module.UTF8ToString(_result);
12187
- free(_result);
12188
- _result = _resultString;
12189
- return _result;
12190
- }
12191
- /**
12192
- * @description Sets the party packaged asset identifier for this asset
12193
- * @param inThirdPartyPackagedAssetIdentifier - The third party packaged asset identifier to set.
12194
- */
12195
- setThirdPartyPackagedAssetIdentifier(thirdPartyPackagedAssetIdentifier) {
12196
- Module.ccall("csp_systems_Asset_SetThirdPartyPackagedAssetIdentifier_void_StringRC", "void", ["number", "string"], [this.pointer, thirdPartyPackagedAssetIdentifier]);
12197
- }
12198
- /**
12199
- * @description Gets the third party platform type of this asset
12200
- * @return Returns a string representing third party platform type set for this asset.
12201
- */
12202
- getThirdPartyPlatformType() {
12203
- let _result = Module.ccall("csp_systems_Asset_GetThirdPartyPlatformTypeC_EThirdPartyPlatformC", "number", ["number"], [this.pointer]);
12204
- return _result;
12205
- }
12206
- /**
12207
- * @description Sets third party platform type for this asset
12208
- * @param inThirdPartyPlatformType - The third party platform type to set.
12209
- */
12210
- setThirdPartyPlatformType(thirdPartyPlatformType) {
12211
- Module.ccall("csp_systems_Asset_SetThirdPartyPlatformType_void_EThirdPartyPlatformC", "void", ["number", "number"], [this.pointer, thirdPartyPlatformType]);
12212
- }
12213
12180
  delete() {
12214
12181
  if (this.ownsPointer && !this.disposed) {
12215
12182
  Module.ccall("csp_systems_Asset_Dtor", "void", ["number"], [this.pointer]);
@@ -12318,6 +12285,20 @@ export class CSPFoundation {
12318
12285
  set externalMimeType(value) {
12319
12286
  Module.ccall("csp_systems_Asset__Set_ExternalMimeType", "void", ["number", "string"], [this.pointer, value]);
12320
12287
  }
12288
+ get thirdPartyPackagedAssetIdentifier() {
12289
+ let _result = Module.ccall("csp_systems_Asset__Get_ThirdPartyPackagedAssetIdentifier", "string", ["number"], [this.pointer]);
12290
+ return _result;
12291
+ }
12292
+ set thirdPartyPackagedAssetIdentifier(value) {
12293
+ Module.ccall("csp_systems_Asset__Set_ThirdPartyPackagedAssetIdentifier", "void", ["number", "string"], [this.pointer, value]);
12294
+ }
12295
+ get thirdPartyPlatformType() {
12296
+ let _result = Module.ccall("csp_systems_Asset__Get_ThirdPartyPlatformType", "number", ["number"], [this.pointer]);
12297
+ return _result;
12298
+ }
12299
+ set thirdPartyPlatformType(value) {
12300
+ Module.ccall("csp_systems_Asset__Set_ThirdPartyPlatformType", "void", ["number", "number"], [this.pointer, value]);
12301
+ }
12321
12302
  }
12322
12303
  Systems.Asset = Asset;
12323
12304
  })(Systems || (Systems = {}));
@@ -15268,7 +15249,9 @@ export class CSPFoundation {
15268
15249
  (function (Multiplayer) {
15269
15250
  /**
15270
15251
  @ingroup AnimatedModelSpaceComponent
15271
- * @description Data representation of an AnimatedModelSpaceComponent.
15252
+ * @description Adds animated skeletal meshes to a SpaceEntity.
15253
+ * /// These are used for objects that need to move or act within the space, such as characters or animated props.
15254
+ * This component makes it possible to play, pause, or loop animations.
15272
15255
  */
15273
15256
  class AnimatedModelSpaceComponent extends Multiplayer.ComponentBase {
15274
15257
  /** @internal */
@@ -15513,7 +15496,9 @@ export class CSPFoundation {
15513
15496
  })(Multiplayer || (Multiplayer = {}));
15514
15497
  (function (Multiplayer) {
15515
15498
  /**
15516
- * @description Data representation of an AudioSpaceComponent.
15499
+ * @description Adds spatial audio to a SpaceEntity.
15500
+ * /// This component creates immersive soundscapes by playing audio that reacts to the user's position in the space.
15501
+ * Whether it's background music, sound effects, or voiceovers, the AudioSpaceComponent makes sound more engaging by positioning it in 3D space.
15517
15502
  */
15518
15503
  class AudioSpaceComponent extends Multiplayer.ComponentBase {
15519
15504
  /** @internal */
@@ -16088,7 +16073,7 @@ export class CSPFoundation {
16088
16073
  (function (Multiplayer) {
16089
16074
  /**
16090
16075
  @ingroup ButtonSpaceComponent
16091
- * @description Data representation of an ButtonSpaceComponent.
16076
+ * @description Add a clickable button to your space. Button click events can be responded to via scripts.
16092
16077
  */
16093
16078
  class ButtonSpaceComponent extends Multiplayer.ComponentBase {
16094
16079
  /** @internal */
@@ -16567,7 +16552,8 @@ export class CSPFoundation {
16567
16552
  (function (Multiplayer) {
16568
16553
  /**
16569
16554
  @ingroup CollisionSpaceComponent
16570
- * @description Data representation of an CollisionSpaceComponent.
16555
+ * @description Add box, mesh, capsule and sphere colliders to objects in your Space.
16556
+ * /// These colliders can act as triggers, which can be used in conjunction with Scripts to drive behavior.
16571
16557
  */
16572
16558
  class CollisionSpaceComponent extends Multiplayer.ComponentBase {
16573
16559
  /** @internal */
@@ -16821,7 +16807,7 @@ export class CSPFoundation {
16821
16807
  (function (Multiplayer) {
16822
16808
  /**
16823
16809
  @ingroup ConversationSpaceComponent
16824
- * @description Data representation of an ConversationSpaceComponent.
16810
+ * @description Add a conversation with comment thread to your space. These conversations have a spatial representation.
16825
16811
  */
16826
16812
  class ConversationSpaceComponent extends Multiplayer.ComponentBase {
16827
16813
  /** @internal */
@@ -17206,7 +17192,7 @@ export class CSPFoundation {
17206
17192
  (function (Multiplayer) {
17207
17193
  /**
17208
17194
  @ingroup CustomSpaceComponent
17209
- * @description Data representation of an CustomSpaceComponent.
17195
+ * @description Can be used to prototype new component types or to support the replication of custom data.
17210
17196
  * NOTE: This class is used to replicate properties of primitive types of properties across multiple platforms.
17211
17197
  * The supported primitive types are the ones supported by the "ReplicatedValue" class.
17212
17198
  */
@@ -17325,7 +17311,8 @@ export class CSPFoundation {
17325
17311
  })(Multiplayer || (Multiplayer = {}));
17326
17312
  (function (Multiplayer) {
17327
17313
  /**
17328
- * @description Data representation of an ECommerceSpaceComponent.
17314
+ * @description Can be used alongside CSP's Stripe integration to add e-commerce to your space.
17315
+ * /// This component is used to represent physical objects that can be purchased as virtual items in the environment.
17329
17316
  */
17330
17317
  class ECommerceSpaceComponent extends Multiplayer.ComponentBase {
17331
17318
  /** @internal */
@@ -17395,8 +17382,7 @@ export class CSPFoundation {
17395
17382
  (function (Multiplayer) {
17396
17383
  /**
17397
17384
  @ingroup ExternalLinkSpaceComponent
17398
- * @description Data representation of an ExternalLinkSpaceComponent.
17399
- * NOTE: This component can be used to handle external URLs that can be opened in game from a space.
17385
+ * @description Used to handle external URLs that can be opened from within a space.
17400
17386
  */
17401
17387
  class ExternalLinkSpaceComponent extends Multiplayer.ComponentBase {
17402
17388
  /** @internal */
@@ -17597,7 +17583,7 @@ export class CSPFoundation {
17597
17583
  (function (Multiplayer) {
17598
17584
  /**
17599
17585
  @ingroup FiducialMarkerSpaceComponent
17600
- * @description Data representation of a FiducialMarkerSpaceComponent.
17586
+ * @description As an alternative to cloud-based anchors, fiducial markers can be used to anchor your space to a physical location.
17601
17587
  */
17602
17588
  class FiducialMarkerSpaceComponent extends Multiplayer.ComponentBase {
17603
17589
  /** @internal */
@@ -17787,7 +17773,7 @@ export class CSPFoundation {
17787
17773
  (function (Multiplayer) {
17788
17774
  /**
17789
17775
  @ingroup FogSpaceComponent
17790
- * @description Data representation of an FogSpaceComponent.
17776
+ * @description Add a depth-based fog volume to your space.
17791
17777
  */
17792
17778
  class FogSpaceComponent extends Multiplayer.ComponentBase {
17793
17779
  /** @internal */
@@ -18082,7 +18068,7 @@ export class CSPFoundation {
18082
18068
  (function (Multiplayer) {
18083
18069
  /**
18084
18070
  @ingroup GaussianSplatSpaceComponent
18085
- * @description Data representation of a GaussianSplatSpaceComponent.
18071
+ * @description Add Gaussian Splats to your space.
18086
18072
  * Gaussian Splatting is a technique for real-time 3D reconstruction and rendering of an object or environment using images taken from multiple
18087
18073
  * 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
18088
18074
  * 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 +18443,7 @@ export class CSPFoundation {
18457
18443
  (function (Multiplayer) {
18458
18444
  /**
18459
18445
  @ingroup ImageSpaceComponent
18460
- * @description Data representation of an ImageSpaceComponent.
18446
+ * @description Add an image to your space.
18461
18447
  */
18462
18448
  class ImageSpaceComponent extends Multiplayer.ComponentBase {
18463
18449
  /** @internal */
@@ -18692,7 +18678,8 @@ export class CSPFoundation {
18692
18678
  (function (Multiplayer) {
18693
18679
  /**
18694
18680
  @ingroup LightSpaceComponent
18695
- * @description Data representation of an LightSpaceComponent.
18681
+ * @description Adds various types of lighting to a SpaceEntity, such as directional, point, or spotlights.
18682
+ * /// This component is essential for creating realistic lighting effects and controlling how objects are illuminated within the space.
18696
18683
  */
18697
18684
  class LightSpaceComponent extends Multiplayer.ComponentBase {
18698
18685
  /** @internal */
@@ -19105,7 +19092,7 @@ export class CSPFoundation {
19105
19092
  (function (Multiplayer) {
19106
19093
  /**
19107
19094
  @ingroup ReflectionSpaceComponent
19108
- * @description Data representation of an ReflectionSpaceComponent.
19095
+ * @description Add sphere and box reflection captures to your Space which can be used by objects with reflective materials.
19109
19096
  */
19110
19097
  class ReflectionSpaceComponent extends Multiplayer.ComponentBase {
19111
19098
  /** @internal */
@@ -19274,7 +19261,9 @@ export class CSPFoundation {
19274
19261
  (function (Multiplayer) {
19275
19262
  /**
19276
19263
  @ingroup ScriptSpaceComponent
19277
- * @description Data representation of a ScriptSpaceComponent.
19264
+ * @description Enables custom behavior through scripting.
19265
+ * /// This component allows developers to author scripts that control how entities and components behave based on specific conditions or user actions.
19266
+ * Scripts can modify entity properties, trigger events, or respond to user inputs.
19278
19267
  */
19279
19268
  class ScriptSpaceComponent extends Multiplayer.ComponentBase {
19280
19269
  /** @internal */
@@ -19421,7 +19410,9 @@ export class CSPFoundation {
19421
19410
  (function (Multiplayer) {
19422
19411
  /**
19423
19412
  @ingroup StaticModelSpaceComponent
19424
- * @description Data representation of an StaticModelSpaceComponent.
19413
+ * @description Adds static 3D models to a SpaceEntity.
19414
+ * /// It displays non-animated objects, such as furniture, buildings, or decorative items within a space.
19415
+ * The static model defines the visual appearance but has no animations or dynamic behaviors.
19425
19416
  */
19426
19417
  class StaticModelSpaceComponent extends Multiplayer.ComponentBase {
19427
19418
  /** @internal */
@@ -19620,7 +19611,7 @@ export class CSPFoundation {
19620
19611
  (function (Multiplayer) {
19621
19612
  /**
19622
19613
  @ingroup TextSpaceComponent
19623
- * @description Data representation of an TextSpaceComponent.
19614
+ * @description Add a spatial representation of text to your space.
19624
19615
  */
19625
19616
  class TextSpaceComponent extends Multiplayer.ComponentBase {
19626
19617
  /** @internal */
@@ -19866,7 +19857,9 @@ export class CSPFoundation {
19866
19857
  (function (Multiplayer) {
19867
19858
  /**
19868
19859
  @ingroup VideoPlayerSpaceComponent
19869
- * @description Data representation of an VideoPlayerSpaceComponent.
19860
+ * @description Enables the playback of video content within the space.
19861
+ * /// 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
19862
+ * environment.
19870
19863
  */
19871
19864
  class VideoPlayerSpaceComponent extends Multiplayer.ComponentBase {
19872
19865
  /** @internal */
@@ -24167,11 +24160,11 @@ export class CSPFoundation {
24167
24160
  return _result;
24168
24161
  }
24169
24162
  getAvatarIdentifier() {
24170
- var _ret = Module._malloc(8);
24171
- Module.ccall("csp_systems_AvatarInfoResult_GetAvatarIdentifierC_VariantRC", "void", ["number", "number"], [_ret, this.pointer]);
24172
- var _nPtr = new Common.Variant(getNativePointer(_ret));
24173
- Module._free(_ret);
24174
- return _nPtr;
24163
+ let _result = Module.ccall("csp_systems_AvatarInfoResult_GetAvatarIdentifierC_StringRC", "number", ["number"], [this.pointer]);
24164
+ const _resultString = Module.UTF8ToString(_result);
24165
+ free(_result);
24166
+ _result = _resultString;
24167
+ return _result;
24175
24168
  }
24176
24169
  delete() {
24177
24170
  if (this.ownsPointer && !this.disposed) {
@@ -24491,7 +24484,7 @@ export class CSPFoundation {
24491
24484
  * @description Retrieves the Avatar Portrait information associated with the space
24492
24485
  * If the user of the Avatar portrait associated with it the result callback will be successful, the HTTP res code will be ResponseNotFound
24493
24486
  * and the Uri field inside the UriResult will be empty
24494
- * @param inUserID - The id of the user we are seelomg to retrieve the portrait for
24487
+ * @param inUserID - The id of the user we are seeking to retrieve the portrait for
24495
24488
  * @param callback - Callback when asynchronous task finishes
24496
24489
  */
24497
24490
  async getAvatarPortrait(userID) {
@@ -24540,7 +24533,7 @@ export class CSPFoundation {
24540
24533
  /**
24541
24534
  * @description Sets the avatar type and identifier for a user.
24542
24535
  * @param inType - The type of avatar (predefined, Ready Player Me, or custom).
24543
- * @param inIdentifier - A value used to identify or locate the avatar. Differs depending on the value of InType.
24536
+ * @param inIdentifier - A string used to identify or locate the avatar.
24544
24537
  * @param callback - Callback to call when task finishes.
24545
24538
  */
24546
24539
  async setAvatarInfo(type, identifier) {
@@ -24559,7 +24552,7 @@ export class CSPFoundation {
24559
24552
  Module.removeFunction(_callbackPtr);
24560
24553
  };
24561
24554
  _callbackPtr = Module.addFunction(_callback, "vii");
24562
- Module.ccall("csp_systems_SettingsSystem_SetAvatarInfo_void_AvatarType_VariantRC_NullResultCallback", "void", ["number", "number", "number", "number", "number"], [this.pointer, type, identifier.pointer, _callbackPtr, 0]);
24555
+ Module.ccall("csp_systems_SettingsSystem_SetAvatarInfo_void_AvatarType_StringRC_NullResultCallback", "void", ["number", "number", "string", "number", "number"], [this.pointer, type, identifier, _callbackPtr, 0]);
24563
24556
  return _promise;
24564
24557
  }
24565
24558
  /**