connected-spaces-platform.web 4.17.1 → 4.19.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.
@@ -156,7 +156,7 @@ export declare namespace Multiplayer {
156
156
  }
157
157
  export declare namespace Multiplayer {
158
158
  /**
159
- * @description Enum used to specify the current state of the muiltiplayer connection.
159
+ * @description Enum used to specify the current state of the multiplayer connection.
160
160
  */
161
161
  enum ConnectionState {
162
162
  Connecting = 0,
@@ -165,6 +165,18 @@ export declare namespace Multiplayer {
165
165
  Disconnected = 3
166
166
  }
167
167
  }
168
+ export declare namespace Multiplayer {
169
+ /**
170
+ * @description Enum used to indicate the failure state of a multiplayer request.
171
+ */
172
+ enum ErrorCode {
173
+ None = 0,
174
+ Unknown = 1,
175
+ NotConnected = 2,
176
+ AlreadyConnected = 3,
177
+ SpaceUserLimitExceeded = 4
178
+ }
179
+ }
168
180
  export declare namespace Multiplayer {
169
181
  /**
170
182
  * @description Enum representing the type of a replicated value.
@@ -192,7 +204,13 @@ export declare namespace Multiplayer {
192
204
  }
193
205
  export declare namespace Multiplayer {
194
206
  /**
195
- * @description Enum used to specify the type of an update operation
207
+ * @description This Enum should be used to determine what kind of operation the component update represents.
208
+ * Update means properties on the component have updated, all need to be checked as we do not provide reference of specific property updates.
209
+ * Add means the component is newly added, clients should ensure that this triggers appropriate instantiation of wrapping objects.
210
+ * All properties for the component should be included.
211
+ * Delete means the component has been marked for deletion. It is likely that some other clients will not have the component at the point this is
212
+ * recieved. Any wrapping data objects should be deleted when this is recieved, and clients should cease updating this component as any call would
213
+ * fail. The CSP representation of the component has been removed at this point.
196
214
  */
197
215
  enum ComponentUpdateType {
198
216
  Update = 0,
@@ -201,6 +219,11 @@ export declare namespace Multiplayer {
201
219
  }
202
220
  }
203
221
  export declare namespace Multiplayer {
222
+ /**
223
+ * @description Enum used to specify what part of a SpaceEntity was updated when deserialising.
224
+ * Use this to determine which parts of an entity to copy values from when an update occurs.
225
+ * It is a bitwise flag enum, so values are additive, the value may represent several flags.
226
+ */
204
227
  enum SpaceEntityUpdateFlags {
205
228
  UPDATE_FLAGS_NAME = 1,
206
229
  UPDATE_FLAGS_POSITION = 2,
@@ -629,7 +652,7 @@ export declare namespace Multiplayer {
629
652
  ReflectionAssetId = 1,
630
653
  AssetCollectionId = 2,
631
654
  Position = 3,
632
- Rotation = 4,
655
+ Rotation_NOT_USED = 4,
633
656
  Scale = 5,
634
657
  ReflectionShape = 6,
635
658
  ThirdPartyComponentRef = 7,
@@ -813,7 +836,8 @@ export declare namespace Systems {
813
836
  TicketAlreadyApplied = 30,
814
837
  ShopifyConnectionBroken = 31,
815
838
  ShopifyInvalidStoreName = 32,
816
- UserShopifyLimitReached = 33
839
+ UserShopifyLimitReached = 33,
840
+ UserTokenRefreshFailed = 34
817
841
  }
818
842
  }
819
843
  export declare namespace Systems {
@@ -916,6 +940,17 @@ export declare namespace Systems {
916
940
  Invalid = 4
917
941
  }
918
942
  }
943
+ export declare namespace Systems {
944
+ /**
945
+ * @description Used to specify the type of the user's avatar
946
+ */
947
+ enum AvatarType {
948
+ None = 0,
949
+ Premade = 1,
950
+ ReadyPlayerMe = 2,
951
+ Custom = 3
952
+ }
953
+ }
919
954
  export declare namespace Systems {
920
955
  enum SpaceAttributes {
921
956
  None = 0,
@@ -1580,15 +1615,6 @@ export declare class CSPFoundation {
1580
1615
  * @return Returns the build ID for the foundation build
1581
1616
  */
1582
1617
  static getBuildID(): string;
1583
- /**
1584
- * @description Gets the EntitySystemVersion number.
1585
- * This represents the system used to parse data for Entities,
1586
- * and is used to prevent conflicting entity data versions from being used together where we cannot parse both.
1587
- * This is currently unused.
1588
- * @return The system version number, a manually incremented counter that changes when significant breaking changes occur in the entity
1589
- * parsing systems
1590
- */
1591
- static getEntitySystemVersion(): number;
1592
1618
  /**
1593
1619
  * @description Unique identifier for the current device.
1594
1620
  * Used internally by certain user authentication endpoints.
@@ -3529,34 +3555,34 @@ export declare namespace Multiplayer {
3529
3555
  static create_boundConnection(boundConnection: Multiplayer.MultiplayerConnection): MultiplayerConnection;
3530
3556
  /**
3531
3557
  * @description Start the connection and register to start receiving updates from the server.
3532
- * @param callback - A callback with success status.
3558
+ * @param callback - A callback with failure state.
3533
3559
  */
3534
- connect(): Promise<boolean>;
3560
+ connect(): Promise<Multiplayer.ErrorCode>;
3535
3561
  /**
3536
3562
  * @description End the multiplayer connection.
3537
- * @param callback - A callback with success status.
3563
+ * @param callback - A callback with failure state.
3538
3564
  */
3539
- disconnect(): Promise<boolean>;
3565
+ disconnect(): Promise<Multiplayer.ErrorCode>;
3540
3566
  /**
3541
3567
  * @description Initialise the connection and get initial entity data from the server.
3542
- * @param callback - A callback with success status.
3568
+ * @param callback - A callback with failure state.
3543
3569
  */
3544
- initialiseConnection(): Promise<boolean>;
3570
+ initialiseConnection(): Promise<Multiplayer.ErrorCode>;
3545
3571
  /**
3546
3572
  * @description Sends a network event by EventName to all currently connected clients.
3547
3573
  * @param eventName - The identifying name for the event.
3548
3574
  * @param args - An array of arguments (ReplicatedValue) to be passed as part of the event payload.
3549
- * @param callback - A status callback which indicates if the event successfully sent.
3575
+ * @param callback - A callback with failure state.
3550
3576
  */
3551
- sendNetworkEvent(eventName: string, args: Common.Array<Multiplayer.ReplicatedValue>): Promise<boolean>;
3577
+ sendNetworkEvent(eventName: string, args: Common.Array<Multiplayer.ReplicatedValue>): Promise<Multiplayer.ErrorCode>;
3552
3578
  /**
3553
3579
  * @description Sends a network event by EventName, to TargetClientId.
3554
3580
  * @param eventName - The identifying name for the event.
3555
3581
  * @param args - An array of arguments (ReplicatedValue) to be passed as part of the event payload.
3556
3582
  * @param targetClientId - The client ID to send the event to.
3557
- * @param callback - A status callback which indicates if the event successfully sent.
3583
+ * @param callback - A callback with failure state.
3558
3584
  */
3559
- sendNetworkEventToClient(eventName: string, args: Common.Array<Multiplayer.ReplicatedValue>, targetClientId: bigint): Promise<boolean>;
3585
+ sendNetworkEventToClient(eventName: string, args: Common.Array<Multiplayer.ReplicatedValue>, targetClientId: bigint): Promise<Multiplayer.ErrorCode>;
3560
3586
  /**
3561
3587
  * @description Sets a callback for a disconnection event.
3562
3588
  * @param callback - The callback for disconnection, contains a string with a reason for disconnection.
@@ -3569,8 +3595,8 @@ export declare namespace Multiplayer {
3569
3595
  setConnectionCallback(callback: (arg1: string) => void): void;
3570
3596
  /**
3571
3597
  * @description Sets a callback for a network interruption event.
3572
- * /// Connection isn't recoverable after this point and Disconnect should be called.
3573
- * /// @param Callback NetworkInterruptionCallbackHandler : The callback for network interruption, contains a string showing failure.
3598
+ * Connection isn't recoverable after this point and Disconnect should be called.
3599
+ * @param callback - The callback for network interruption, contains a string showing failure.
3574
3600
  */
3575
3601
  setNetworkInterruptionCallback(callback: (arg1: string) => void): void;
3576
3602
  /**
@@ -3622,12 +3648,12 @@ export declare namespace Multiplayer {
3622
3648
  getConnectionState(): Multiplayer.ConnectionState;
3623
3649
  /**
3624
3650
  * @description Sets the Self Messaging flag for this client.
3625
- * /// This allows a client to declare that it wishes to recieve every patch and object message it sends.
3626
- * /// @warning Don't use this function if you aren't sure of the consequences, it's very unlikely that a client would want to use this!
3651
+ * This allows a client to declare that it wishes to recieve every patch and object message it sends.
3652
+ @warning Don't use this function if you aren't sure of the consequences, it's very unlikely that a client would want to use this!
3627
3653
  * @param allowSelfMessaging - True to allow and false to disallow.
3628
- * @param callback - Callback providing success/fail boolean.
3654
+ * @param callback - A callback with failure state.
3629
3655
  */
3630
- setAllowSelfMessagingFlag(allowSelfMessaging: boolean): Promise<boolean>;
3656
+ setAllowSelfMessagingFlag(allowSelfMessaging: boolean): Promise<Multiplayer.ErrorCode>;
3631
3657
  /**
3632
3658
  * @description Gets the bool representing if we're using self-messaging or not.
3633
3659
  * @return True if self messaging is allowed, false otherwise.
@@ -3766,18 +3792,6 @@ export declare namespace Multiplayer {
3766
3792
  getVector4(): Common.Vector4;
3767
3793
  }
3768
3794
  }
3769
- export declare namespace Multiplayer {
3770
- class PropertyUpdateInfo extends NativeClassWrapper implements INativeResource {
3771
- /** @internal */
3772
- constructor(pointer: NativePointer);
3773
- static create(): PropertyUpdateInfo;
3774
- delete(): void;
3775
- get propertyId(): number;
3776
- set propertyId(value: number);
3777
- get updateType(): Multiplayer.ComponentUpdateType;
3778
- set updateType(value: Multiplayer.ComponentUpdateType);
3779
- }
3780
- }
3781
3795
  export declare namespace Multiplayer {
3782
3796
  /**
3783
3797
  * @description Info class that specifies a type of update and the ID of a component the update is applied to.
@@ -3920,6 +3934,7 @@ export declare namespace Multiplayer {
3920
3934
  * @description Set a callback to be executed when a patch message is received for this Entity. Only one callback can be set.
3921
3935
  * @param callback - Contains the SpaceEntity that updated, a set of flags to tell which parts updated
3922
3936
  * and an array of information to tell which components updated.
3937
+ * When this callback is recieved, the flags and arrays should be used to determine which properties have updated data.
3923
3938
  */
3924
3939
  setUpdateCallback(callback: (arg1: Multiplayer.SpaceEntity, arg2: Multiplayer.SpaceEntityUpdateFlags, arg3: Common.Array<Multiplayer.ComponentUpdateInfo>) => void): void;
3925
3940
  /**
@@ -4006,6 +4021,12 @@ export declare namespace Multiplayer {
4006
4021
  * /// @return True if deselection occurred. False if not.
4007
4022
  */
4008
4023
  deselect(): boolean;
4024
+ /**
4025
+ * @description Checks if the entity can be modified.
4026
+ * Specifically whether the local client already owns the entity or can take ownership of the entity.
4027
+ * @return True if the entity can be modified, False if not.
4028
+ */
4029
+ isModifiable(): boolean;
4009
4030
  }
4010
4031
  }
4011
4032
  export declare namespace Multiplayer {
@@ -4633,7 +4654,6 @@ export declare namespace Systems {
4633
4654
  class AnalyticsSystem extends NativeClassWrapper {
4634
4655
  /** @internal */
4635
4656
  constructor(pointer: NativePointer);
4636
- static create(): AnalyticsSystem;
4637
4657
  /**
4638
4658
  * @description Send an event
4639
4659
  * @param event - AnalyticsEvent
@@ -4808,8 +4828,8 @@ export declare namespace Systems {
4808
4828
  set pointOfInterestId(value: string);
4809
4829
  get parentId(): string;
4810
4830
  set parentId(value: string);
4811
- get spaceIds(): Common.Array<string>;
4812
- set spaceIds(value: Common.Array<string>);
4831
+ get spaceId(): string;
4832
+ set spaceId(value: string);
4813
4833
  get createdBy(): string;
4814
4834
  set createdBy(value: string);
4815
4835
  get createdAt(): string;
@@ -5153,6 +5173,25 @@ export declare namespace Systems {
5153
5173
  * @param level - The level to check.
5154
5174
  */
5155
5175
  loggingEnabled(level: Systems.LogLevel): boolean;
5176
+ /**
5177
+ * @description Log a message at a specific verbosity level.
5178
+ * @param level - The level to log this message at.
5179
+ * @param inMessage - The message to be logged.
5180
+ */
5181
+ logMsg(level: Systems.LogLevel, message: string): void;
5182
+ /**
5183
+ * @description Log an event.
5184
+ * @param inEvent - The event to be logged.
5185
+ */
5186
+ logEvent(event: string): void;
5187
+ /**
5188
+ * @description Specify a 'Marker' event which can be used to communicate a certain process occurring, usually for debugging.
5189
+ */
5190
+ beginMarker(marker: string): void;
5191
+ /**
5192
+ * @description End a 'Marker' event.
5193
+ */
5194
+ endMarker(): void;
5156
5195
  /**
5157
5196
  * @description Clears all logging callbacks.
5158
5197
  */
@@ -5612,10 +5651,10 @@ export declare namespace Systems {
5612
5651
  delete(): void;
5613
5652
  get agoraUserId(): string;
5614
5653
  set agoraUserId(value: string);
5615
- get lifespan(): number;
5616
- set lifespan(value: number);
5617
5654
  get channelName(): string;
5618
5655
  set channelName(value: string);
5656
+ get lifespan(): number;
5657
+ set lifespan(value: number);
5619
5658
  get readOnly(): boolean;
5620
5659
  set readOnly(value: boolean);
5621
5660
  get shareAudio(): boolean;
@@ -5701,7 +5740,13 @@ export declare namespace Multiplayer {
5701
5740
  * @param parent - The Space entity that owns this component.
5702
5741
  */
5703
5742
  static create_parent(parent: Multiplayer.SpaceEntity): AnimatedModelSpaceComponent;
5743
+ /** @deprecated
5744
+ Due to the introduction of LODs it doesn't make sense to set a specific asset anymore
5745
+ */
5704
5746
  getExternalResourceAssetId(): string;
5747
+ /** @deprecated
5748
+ Due to the introduction of LODs it doesn't make sense to set a specific asset anymore
5749
+ */
5705
5750
  setExternalResourceAssetId(value: string): void;
5706
5751
  /**
5707
5752
  * @description Gets the ID of the asset collection associated with this component.
@@ -5827,7 +5872,7 @@ export declare namespace Multiplayer {
5827
5872
  /**
5828
5873
  * @description Data representation of an AudioSpaceComponent.
5829
5874
  */
5830
- class AudioSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
5875
+ class AudioSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.IPositionComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
5831
5876
  /** @internal */
5832
5877
  constructor(pointer: NativePointer);
5833
5878
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.AudioSpaceComponent;
@@ -5837,25 +5882,17 @@ export declare namespace Multiplayer {
5837
5882
  */
5838
5883
  static create_parent(parent: Multiplayer.SpaceEntity): AudioSpaceComponent;
5839
5884
  /**
5840
- * @description Gets the position of the origin of this component in world space.
5841
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
5842
- * - Right handed coordinate system
5843
- * - +Y is UP
5844
- * - +X is left (facing forward)
5845
- * - +Z is forward
5846
- * @return The 3D position as vector (left, up, forward) in meters.
5885
+ * \addtogroup IPositionComponent
5886
+ @{
5887
+ @copydoc IPositionComponent::GetPosition()
5847
5888
  */
5848
5889
  getPosition(): Common.Vector3;
5849
5890
  /**
5850
- * @description Sets the position of the origin of this component in world space.
5851
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
5852
- * - Right handed coordinate system
5853
- * - +Y is UP
5854
- * - +X is left (facing forward)
5855
- * - +Z is forward
5891
+ @copydoc IPositionComponent::SetPosition()
5856
5892
  */
5857
5893
  setPosition(value: Common.Vector3): void;
5858
5894
  /**
5895
+ @}
5859
5896
  * @description Gets the current playback state of the audio of this audio component.
5860
5897
  * @return The current playback state of the audio of this audio component.
5861
5898
  */
@@ -6200,7 +6237,7 @@ export declare namespace Multiplayer {
6200
6237
  @ingroup ButtonSpaceComponent
6201
6238
  * @description Data representation of an ButtonSpaceComponent.
6202
6239
  */
6203
- class ButtonSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.IVisibleComponent, INativeResource {
6240
+ class ButtonSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
6204
6241
  /** @internal */
6205
6242
  constructor(pointer: NativePointer);
6206
6243
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.ButtonSpaceComponent;
@@ -6244,70 +6281,41 @@ export declare namespace Multiplayer {
6244
6281
  */
6245
6282
  setAssetCollectionId(value: string): void;
6246
6283
  /**
6247
- * @description Gets the position of the origin of this component in world space.
6248
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
6249
- * - Right handed coordinate system
6250
- * - +Y is UP
6251
- * - +X is left (facing forward)
6252
- * - +Z is forward
6253
- * @return The 3D position as vector (left, up, forward) in meters.
6284
+ * \addtogroup ITransformComponent
6285
+ @{
6286
+ @copydoc IPositionComponent::GetPosition()
6254
6287
  */
6255
6288
  getPosition(): Common.Vector3;
6256
6289
  /**
6257
- * @description Sets the position of the origin of this component in world space.
6258
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
6259
- * - Right handed coordinate system
6260
- * - +Y is UP
6261
- * - +X is left (facing forward)
6262
- * - +Z is forward
6290
+ @copydoc IPositionComponent::SetPosition()
6263
6291
  */
6264
6292
  setPosition(value: Common.Vector3): void;
6265
6293
  /**
6266
- * @description Gets a quaternion representing the rotation of the origin of this component, expressed in radians.
6267
- * NOTE: The coordinate system respects the following conventions:
6268
- * - Right handed coordinate system
6269
- * - Positive rotation is counterclockwise
6270
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
6271
- * - North: +Z
6272
- * - East: -X
6273
- * - South: -Z
6274
- * - West: +X
6294
+ @copydoc IRotationComponent::GetRotation()
6275
6295
  */
6276
6296
  getRotation(): Common.Vector4;
6277
6297
  /**
6278
- * @description Sets the rotation of the origin of this component according to the specified quaternion "Value", expressed in radians.
6279
- * NOTE: The coordinate system respects the following conventions:
6280
- * - Right handed coordinate system
6281
- * - Positive rotation is counterclockwise
6282
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
6283
- * - North: +Z
6284
- * - East: -X
6285
- * - South: -Z
6286
- * - West: +X
6287
- * @param value - The quaternion in radians to use as new rotation of this component.
6298
+ @copydoc IRotationComponent::SetRotation()
6288
6299
  */
6289
6300
  setRotation(value: Common.Vector4): void;
6290
6301
  /**
6291
- * @description Gets the scale of the origin of this component in world space.
6292
- * NOTE: The coordinate system used follows the glTF 2.0 specification.
6293
- * - Right handed coordinate system
6294
- * - +Y is UP
6295
- * - +X is left (facing forward)
6296
- * - +Z is forward
6297
- * @return The 3D scale as vector (left, up, forward).
6302
+ @copydoc IScaleComponent::GetScale()
6298
6303
  */
6299
6304
  getScale(): Common.Vector3;
6300
6305
  /**
6301
- * @description Sets the scale of the origin of this component in world space to the specified "Value".
6302
- * @param value - The new value expressed as vector (left, up, forward).
6303
- * NOTE: The coordinate system used follows the glTF 2.0 specification.
6304
- * - Right handed coordinate system
6305
- * - +Y is UP
6306
- * - +X is left (facing forward)
6307
- * - +Z is forward
6306
+ @copydoc IScaleComponent::SetScale()
6308
6307
  */
6309
6308
  setScale(value: Common.Vector3): void;
6310
6309
  /**
6310
+ @copydoc ITransformComponent::GetTransform()
6311
+ */
6312
+ getTransform(): Multiplayer.SpaceTransform;
6313
+ /**
6314
+ @copydoc ITransformComonent::SetTransform()
6315
+ */
6316
+ setTransform(value: Multiplayer.SpaceTransform): void;
6317
+ /**
6318
+ @}
6311
6319
  * \addtogroup IClickableComponent
6312
6320
  @{
6313
6321
  @copydoc IClickableComponent::GetIsEnabled()
@@ -6344,7 +6352,7 @@ export declare namespace Multiplayer {
6344
6352
  @ingroup CollisionSpaceComponent
6345
6353
  * @description Data representation of an CollisionSpaceComponent.
6346
6354
  */
6347
- class CollisionSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IThirdPartyComponentRef, INativeResource {
6355
+ class CollisionSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, INativeResource {
6348
6356
  /** @internal */
6349
6357
  constructor(pointer: NativePointer);
6350
6358
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.CollisionSpaceComponent;
@@ -6354,70 +6362,41 @@ export declare namespace Multiplayer {
6354
6362
  */
6355
6363
  static create_parent(parent: Multiplayer.SpaceEntity): CollisionSpaceComponent;
6356
6364
  /**
6357
- * @description Gets the position of the origin of this component in world space.
6358
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
6359
- * - Right handed coordinate system
6360
- * - +Y is UP
6361
- * - +X is left (facing forward)
6362
- * - +Z is forward
6363
- * @return The 3D position as vector (left, up, forward) in meters.
6365
+ * \addtogroup ITransformComponent
6366
+ @{
6367
+ @copydoc IPositionComponent::GetPosition()
6364
6368
  */
6365
6369
  getPosition(): Common.Vector3;
6366
6370
  /**
6367
- * @description Sets the position of the origin of this component in world space.
6368
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
6369
- * - Right handed coordinate system
6370
- * - +Y is UP
6371
- * - +X is left (facing forward)
6372
- * - +Z is forward
6371
+ @copydoc IPositionComponent::SetPosition()
6373
6372
  */
6374
6373
  setPosition(value: Common.Vector3): void;
6375
6374
  /**
6376
- * @description Gets a quaternion representing the rotation of the origin of this component, expressed in radians.
6377
- * NOTE: The coordinate system respects the following conventions:
6378
- * - Right handed coordinate system
6379
- * - Positive rotation is counterclockwise
6380
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
6381
- * - North: +Z
6382
- * - East: -X
6383
- * - South: -Z
6384
- * - West: +X
6375
+ @copydoc IRotationComponent::GetRotation()
6385
6376
  */
6386
6377
  getRotation(): Common.Vector4;
6387
6378
  /**
6388
- * @description Sets the rotation of the origin of this component according to the specified quaternion "Value", expressed in radians.
6389
- * NOTE: The coordinate system respects the following conventions:
6390
- * - Right handed coordinate system
6391
- * - Positive rotation is counterclockwise
6392
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
6393
- * - North: +Z
6394
- * - East: -X
6395
- * - South: -Z
6396
- * - West: +X
6397
- * @param value - The quaternion in radians to use as new rotation of this component.
6379
+ @copydoc IRotationComponent::SetRotation()
6398
6380
  */
6399
6381
  setRotation(value: Common.Vector4): void;
6400
6382
  /**
6401
- * @description Gets the scale of the origin of this component in world space.
6402
- * NOTE: The coordinate system used follows the glTF 2.0 specification.
6403
- * - Right handed coordinate system
6404
- * - +Y is UP
6405
- * - +X is left (facing forward)
6406
- * - +Z is forward
6407
- * @return The 3D scale as vector (left, up, forward).
6383
+ @copydoc IScaleComponent::GetScale()
6408
6384
  */
6409
6385
  getScale(): Common.Vector3;
6410
6386
  /**
6411
- * @description Sets the scale of the origin of this component in world space to the specified "Value".
6412
- * @param value - The new value expressed as vector (left, up, forward).
6413
- * NOTE: The coordinate system used follows the glTF 2.0 specification.
6414
- * - Right handed coordinate system
6415
- * - +Y is UP
6416
- * - +X is left (facing forward)
6417
- * - +Z is forward
6387
+ @copydoc IScaleComponent::SetScale()
6418
6388
  */
6419
6389
  setScale(value: Common.Vector3): void;
6420
6390
  /**
6391
+ @copydoc ITransformComponent::GetTransform()
6392
+ */
6393
+ getTransform(): Multiplayer.SpaceTransform;
6394
+ /**
6395
+ @copydoc ITransformComonent::SetTransform()
6396
+ */
6397
+ setTransform(value: Multiplayer.SpaceTransform): void;
6398
+ /**
6399
+ @}
6421
6400
  * @description Gets the collision shape used by this collision component.
6422
6401
  * @return The colllision shape used by this collision component.
6423
6402
  */
@@ -6512,7 +6491,7 @@ export declare namespace Multiplayer {
6512
6491
  @ingroup ConversationSpaceComponent
6513
6492
  * @description Data representation of an ConversationSpaceComponent.
6514
6493
  */
6515
- class ConversationSpaceComponent extends Multiplayer.ComponentBase implements INativeResource {
6494
+ class ConversationSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, Multiplayer.IRotationComponent, INativeResource {
6516
6495
  /** @internal */
6517
6496
  constructor(pointer: NativePointer);
6518
6497
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.ConversationSpaceComponent;
@@ -6581,23 +6560,29 @@ export declare namespace Multiplayer {
6581
6560
  */
6582
6561
  setMessageInfo(messageId: string, messageData: Multiplayer.MessageInfo): Promise<Multiplayer.MessageResult>;
6583
6562
  /**
6584
- * @description Gets the relative 3D position of this component.
6563
+ * \addtogroup IPositionComponent
6564
+ @{
6565
+ @copydoc IPositionComponent::GetPosition()
6585
6566
  */
6586
6567
  getPosition(): Common.Vector3;
6587
6568
  /**
6588
- * @description Sets the relative 3D position of this component.
6589
- * @param value - - The new 3D position assigned to the origin of this component.
6569
+ @copydoc IPositionComponent::SetPosition()
6590
6570
  */
6591
6571
  setPosition(value: Common.Vector3): void;
6592
6572
  /**
6593
- * @description Gets the quaternion of the rotation of the origin of this component.
6573
+ @}
6574
+ * \addtogroup IRotationComponent
6575
+ @{
6576
+ @copydoc IRotationComponent::GetRotation()
6594
6577
  */
6595
6578
  getRotation(): Common.Vector4;
6596
6579
  /**
6597
- * @description Sets the quaternion of the rotation of the origin of this component.
6598
- * @param value - - The new rotation assigned to the origin of this component.
6580
+ @copydoc IRotationComponent::SetRotation()
6599
6581
  */
6600
6582
  setRotation(value: Common.Vector4): void;
6583
+ /**
6584
+ @}
6585
+ */
6601
6586
  getIsVisible(): boolean;
6602
6587
  setIsVisible(value: boolean): void;
6603
6588
  getIsActive(): boolean;
@@ -6710,7 +6695,7 @@ export declare namespace Multiplayer {
6710
6695
  /**
6711
6696
  * @description Data representation of an ECommerceSpaceComponent.
6712
6697
  */
6713
- class ECommerceSpaceComponent extends Multiplayer.ComponentBase implements INativeResource {
6698
+ class ECommerceSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, INativeResource {
6714
6699
  /** @internal */
6715
6700
  constructor(pointer: NativePointer);
6716
6701
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.ECommerceSpaceComponent;
@@ -6720,25 +6705,17 @@ export declare namespace Multiplayer {
6720
6705
  */
6721
6706
  static create_parent(parent: Multiplayer.SpaceEntity): ECommerceSpaceComponent;
6722
6707
  /**
6723
- * @description Gets the position of the origin of this component in world space.
6724
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
6725
- * - Right handed coordinate system
6726
- * - +Y is UP
6727
- * - +X is left (facing forward)
6728
- * - +Z is forward
6729
- * @return The 3D position as vector (left, up, forward) in meters.
6708
+ * \addtogroup ITransformComponent
6709
+ @{
6710
+ @copydoc IPositionComponent::GetPosition()
6730
6711
  */
6731
6712
  getPosition(): Common.Vector3;
6732
6713
  /**
6733
- * @description Sets the position of the origin of this component in world space.
6734
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
6735
- * - Right handed coordinate system
6736
- * - +Y is UP
6737
- * - +X is left (facing forward)
6738
- * - +Z is forward
6714
+ @copydoc IPositionComponent::SetPosition()
6739
6715
  */
6740
6716
  setPosition(value: Common.Vector3): void;
6741
6717
  /**
6718
+ @}
6742
6719
  * @description Gets the product ID associated with the ECommerce component.
6743
6720
  * @return The product ID associated with the ECommerce component.
6744
6721
  */
@@ -6757,7 +6734,7 @@ export declare namespace Multiplayer {
6757
6734
  * @description Data representation of an ExternalLinkSpaceComponent.
6758
6735
  * NOTE: This component can be used to handle external URLs that can be opened in game from a space.
6759
6736
  */
6760
- class ExternalLinkSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.IVisibleComponent, INativeResource {
6737
+ class ExternalLinkSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
6761
6738
  /** @internal */
6762
6739
  constructor(pointer: NativePointer);
6763
6740
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.ExternalLinkSpaceComponent;
@@ -6785,33 +6762,41 @@ export declare namespace Multiplayer {
6785
6762
  */
6786
6763
  setLinkUrl(value: string): void;
6787
6764
  /**
6788
- * @description Gets the 3D position in world coordinates where the origin of this component is located.
6765
+ * \addtogroup ITransformComponent
6766
+ @{
6767
+ @copydoc IPositionComponent::GetPosition()
6789
6768
  */
6790
6769
  getPosition(): Common.Vector3;
6791
6770
  /**
6792
- * @description Sets the 3D position in world coordinates where the origin of this component will be located.
6793
- * @param value - - The new 3D position assigned to the origin of this component.
6771
+ @copydoc IPositionComponent::SetPosition()
6794
6772
  */
6795
6773
  setPosition(value: Common.Vector3): void;
6796
6774
  /**
6797
- * @description Gets the quaternion of the rotation of the origin of this component.
6775
+ @copydoc IRotationComponent::GetRotation()
6798
6776
  */
6799
6777
  getRotation(): Common.Vector4;
6800
6778
  /**
6801
- * @description Sets the quaternion of the rotation of the origin of this component.
6802
- * @param value - - The new rotation assigned to the origin of this component.
6779
+ @copydoc IRotationComponent::SetRotation()
6803
6780
  */
6804
6781
  setRotation(value: Common.Vector4): void;
6805
6782
  /**
6806
- * @description Gets the 3D scale of this component.
6783
+ @copydoc IScaleComponent::GetScale()
6807
6784
  */
6808
6785
  getScale(): Common.Vector3;
6809
6786
  /**
6810
- * @description Sets the 3D scale of this component.
6811
- * @param value - - The new 3D scale assigned to this component.
6787
+ @copydoc IScaleComponent::SetScale()
6812
6788
  */
6813
6789
  setScale(value: Common.Vector3): void;
6814
6790
  /**
6791
+ @copydoc ITransformComponent::GetTransform()
6792
+ */
6793
+ getTransform(): Multiplayer.SpaceTransform;
6794
+ /**
6795
+ @copydoc ITransformComonent::SetTransform()
6796
+ */
6797
+ setTransform(value: Multiplayer.SpaceTransform): void;
6798
+ /**
6799
+ @}
6815
6800
  * @description Gets the text that will be displayed by the component as hyperlink to the URL it redirects to.
6816
6801
  */
6817
6802
  getDisplayText(): string;
@@ -6857,7 +6842,7 @@ export declare namespace Multiplayer {
6857
6842
  @ingroup FiducialMarkerSpaceComponent
6858
6843
  * @description Data representation of a FiducialMarkerSpaceComponent.
6859
6844
  */
6860
- class FiducialMarkerSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IVisibleComponent, INativeResource {
6845
+ class FiducialMarkerSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
6861
6846
  /** @internal */
6862
6847
  constructor(pointer: NativePointer);
6863
6848
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.FiducialMarkerSpaceComponent;
@@ -6899,70 +6884,41 @@ export declare namespace Multiplayer {
6899
6884
  */
6900
6885
  setAssetCollectionId(value: string): void;
6901
6886
  /**
6902
- * @description Gets the position of the origin of this component in world space.
6903
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
6904
- * - Right handed coordinate system
6905
- * - +Y is UP
6906
- * - +X is left (facing forward)
6907
- * - +Z is forward
6908
- * @return The 3D position as vector (left, up, forward) in meters.
6887
+ * \addtogroup ITransformComponent
6888
+ @{
6889
+ @copydoc IPositionComponent::GetPosition()
6909
6890
  */
6910
6891
  getPosition(): Common.Vector3;
6911
6892
  /**
6912
- * @description Sets the position of the origin of this component in world space.
6913
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
6914
- * - Right handed coordinate system
6915
- * - +Y is UP
6916
- * - +X is left (facing forward)
6917
- * - +Z is forward
6893
+ @copydoc IPositionComponent::SetPosition()
6918
6894
  */
6919
6895
  setPosition(value: Common.Vector3): void;
6920
6896
  /**
6921
- * @description Gets a quaternion representing the rotation of the origin of this component, expressed in radians.
6922
- * NOTE: The coordinate system respects the following conventions:
6923
- * - Right handed coordinate system
6924
- * - Positive rotation is counterclockwise
6925
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
6926
- * - North: +Z
6927
- * - East: -X
6928
- * - South: -Z
6929
- * - West: +X
6897
+ @copydoc IRotationComponent::GetRotation()
6930
6898
  */
6931
6899
  getRotation(): Common.Vector4;
6932
6900
  /**
6933
- * @description Sets the rotation of the origin of this component according to the specified quaternion "Value", expressed in radians.
6934
- * NOTE: The coordinate system respects the following conventions:
6935
- * - Right handed coordinate system
6936
- * - Positive rotation is counterclockwise
6937
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
6938
- * - North: +Z
6939
- * - East: -X
6940
- * - South: -Z
6941
- * - West: +X
6942
- * @param value - The quaternion in radians to use as new rotation of this component.
6901
+ @copydoc IRotationComponent::SetRotation()
6943
6902
  */
6944
6903
  setRotation(value: Common.Vector4): void;
6945
6904
  /**
6946
- * @description Gets the scale of the origin of this component in world space.
6947
- * NOTE: The coordinate system used follows the glTF 2.0 specification.
6948
- * - Right handed coordinate system
6949
- * - +Y is UP
6950
- * - +X is left (facing forward)
6951
- * - +Z is forward
6952
- * @return The 3D scale as vector (left, up, forward).
6905
+ @copydoc IScaleComponent::GetScale()
6953
6906
  */
6954
6907
  getScale(): Common.Vector3;
6955
6908
  /**
6956
- * @description Sets the scale of the origin of this component in world space to the specified "Value".
6957
- * @param value - The new value expressed as vector (left, up, forward).
6958
- * NOTE: The coordinate system used follows the glTF 2.0 specification.
6959
- * - Right handed coordinate system
6960
- * - +Y is UP
6961
- * - +X is left (facing forward)
6962
- * - +Z is forward
6909
+ @copydoc IScaleComponent::SetScale()
6963
6910
  */
6964
6911
  setScale(value: Common.Vector3): void;
6965
6912
  /**
6913
+ @copydoc ITransformComponent::GetTransform()
6914
+ */
6915
+ getTransform(): Multiplayer.SpaceTransform;
6916
+ /**
6917
+ @copydoc ITransformComonent::SetTransform()
6918
+ */
6919
+ setTransform(value: Multiplayer.SpaceTransform): void;
6920
+ /**
6921
+ @}
6966
6922
  * \addtogroup IVisibleComponent
6967
6923
  @{
6968
6924
  @copydoc IVisibleComponent::GetIsVisible()
@@ -6988,7 +6944,7 @@ export declare namespace Multiplayer {
6988
6944
  @ingroup FogSpaceComponent
6989
6945
  * @description Data representation of an FogSpaceComponent.
6990
6946
  */
6991
- class FogSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IVisibleComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
6947
+ class FogSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
6992
6948
  /** @internal */
6993
6949
  constructor(pointer: NativePointer);
6994
6950
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.FogSpaceComponent;
@@ -7008,70 +6964,41 @@ export declare namespace Multiplayer {
7008
6964
  */
7009
6965
  setFogMode(value: Multiplayer.FogMode): void;
7010
6966
  /**
7011
- * @description Gets the position of the origin of this component in world space.
7012
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
7013
- * - Right handed coordinate system
7014
- * - +Y is UP
7015
- * - +X is left (facing forward)
7016
- * - +Z is forward
7017
- * @return The 3D position as vector (left, up, forward) in meters.
6967
+ * \addtogroup ITransformComponent
6968
+ @{
6969
+ @copydoc IPositionComponent::GetPosition()
7018
6970
  */
7019
6971
  getPosition(): Common.Vector3;
7020
6972
  /**
7021
- * @description Sets the position of the origin of this component in world space.
7022
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
7023
- * - Right handed coordinate system
7024
- * - +Y is UP
7025
- * - +X is left (facing forward)
7026
- * - +Z is forward
6973
+ @copydoc IPositionComponent::SetPosition()
7027
6974
  */
7028
6975
  setPosition(value: Common.Vector3): void;
7029
6976
  /**
7030
- * @description Gets a quaternion representing the rotation of the origin of this component, expressed in radians.
7031
- * NOTE: The coordinate system respects the following conventions:
7032
- * - Right handed coordinate system
7033
- * - Positive rotation is counterclockwise
7034
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
7035
- * - North: +Z
7036
- * - East: -X
7037
- * - South: -Z
7038
- * - West: +X
6977
+ @copydoc IRotationComponent::GetRotation()
7039
6978
  */
7040
6979
  getRotation(): Common.Vector4;
7041
6980
  /**
7042
- * @description Sets the rotation of the origin of this component according to the specified quaternion "Value", expressed in radians.
7043
- * NOTE: The coordinate system respects the following conventions:
7044
- * - Right handed coordinate system
7045
- * - Positive rotation is counterclockwise
7046
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
7047
- * - North: +Z
7048
- * - East: -X
7049
- * - South: -Z
7050
- * - West: +X
7051
- * @param value - The quaternion in radians to use as new rotation of this component.
6981
+ @copydoc IRotationComponent::SetRotation()
7052
6982
  */
7053
6983
  setRotation(value: Common.Vector4): void;
7054
6984
  /**
7055
- * @description Gets the scale of the origin of this component in world space.
7056
- * NOTE: The coordinate system used follows the glTF 2.0 specification.
7057
- * - Right handed coordinate system
7058
- * - +Y is UP
7059
- * - +X is left (facing forward)
7060
- * - +Z is forward
7061
- * @return The 3D scale as vector (left, up, forward).
6985
+ @copydoc IScaleComponent::GetScale()
7062
6986
  */
7063
6987
  getScale(): Common.Vector3;
7064
6988
  /**
7065
- * @description Sets the scale of the origin of this component in world space to the specified "Value".
7066
- * @param value - The new value expressed as vector (left, up, forward).
7067
- * NOTE: The coordinate system used follows the glTF 2.0 specification.
7068
- * - Right handed coordinate system
7069
- * - +Y is UP
7070
- * - +X is left (facing forward)
7071
- * - +Z is forward
6989
+ @copydoc IScaleComponent::SetScale()
7072
6990
  */
7073
6991
  setScale(value: Common.Vector3): void;
7074
6992
  /**
6993
+ @copydoc ITransformComponent::GetTransform()
6994
+ */
6995
+ getTransform(): Multiplayer.SpaceTransform;
6996
+ /**
6997
+ @copydoc ITransformComonent::SetTransform()
6998
+ */
6999
+ setTransform(value: Multiplayer.SpaceTransform): void;
7000
+ /**
7001
+ @}
7075
7002
  * @description Get start sistance
7076
7003
  * Note: Distance from camera that the fog will start.
7077
7004
  * Note: 0 = this property has no effect.
@@ -7193,7 +7120,7 @@ export declare namespace Multiplayer {
7193
7120
  @ingroup ImageSpaceComponent
7194
7121
  * @description Data representation of an ImageSpaceComponent.
7195
7122
  */
7196
- class ImageSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IVisibleComponent, INativeResource {
7123
+ class ImageSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
7197
7124
  /** @internal */
7198
7125
  constructor(pointer: NativePointer);
7199
7126
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.ImageSpaceComponent;
@@ -7235,70 +7162,41 @@ export declare namespace Multiplayer {
7235
7162
  */
7236
7163
  setAssetCollectionId(value: string): void;
7237
7164
  /**
7238
- * @description Gets the position of the origin of this component in world space.
7239
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
7240
- * - Right handed coordinate system
7241
- * - +Y is UP
7242
- * - +X is left (facing forward)
7243
- * - +Z is forward
7244
- * @return The 3D position as vector (left, up, forward) in meters.
7165
+ * \addtogroup ITransformComponent
7166
+ @{
7167
+ @copydoc IPositionComponent::GetPosition()
7245
7168
  */
7246
7169
  getPosition(): Common.Vector3;
7247
7170
  /**
7248
- * @description Sets the position of the origin of this component in world space.
7249
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
7250
- * - Right handed coordinate system
7251
- * - +Y is UP
7252
- * - +X is left (facing forward)
7253
- * - +Z is forward
7171
+ @copydoc IPositionComponent::SetPosition()
7254
7172
  */
7255
7173
  setPosition(value: Common.Vector3): void;
7256
7174
  /**
7257
- * @description Gets a quaternion representing the rotation of the origin of this component, expressed in radians.
7258
- * NOTE: The coordinate system respects the following conventions:
7259
- * - Right handed coordinate system
7260
- * - Positive rotation is counterclockwise
7261
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
7262
- * - North: +Z
7263
- * - East: -X
7264
- * - South: -Z
7265
- * - West: +X
7175
+ @copydoc IRotationComponent::GetRotation()
7266
7176
  */
7267
7177
  getRotation(): Common.Vector4;
7268
7178
  /**
7269
- * @description Sets the rotation of the origin of this component according to the specified quaternion "Value", expressed in radians.
7270
- * NOTE: The coordinate system respects the following conventions:
7271
- * - Right handed coordinate system
7272
- * - Positive rotation is counterclockwise
7273
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
7274
- * - North: +Z
7275
- * - East: -X
7276
- * - South: -Z
7277
- * - West: +X
7278
- * @param value - The quaternion in radians to use as new rotation of this component.
7179
+ @copydoc IRotationComponent::SetRotation()
7279
7180
  */
7280
7181
  setRotation(value: Common.Vector4): void;
7281
7182
  /**
7282
- * @description Gets the scale of the origin of this component in world space.
7283
- * NOTE: The coordinate system used follows the glTF 2.0 specification.
7284
- * - Right handed coordinate system
7285
- * - +Y is UP
7286
- * - +X is left (facing forward)
7287
- * - +Z is forward
7288
- * @return The 3D scale as vector (left, up, forward).
7183
+ @copydoc IScaleComponent::GetScale()
7289
7184
  */
7290
7185
  getScale(): Common.Vector3;
7291
7186
  /**
7292
- * @description Sets the scale of the origin of this component in world space to the specified "Value".
7293
- * @param value - The new value expressed as vector (left, up, forward).
7294
- * NOTE: The coordinate system used follows the glTF 2.0 specification.
7295
- * - Right handed coordinate system
7296
- * - +Y is UP
7297
- * - +X is left (facing forward)
7298
- * - +Z is forward
7187
+ @copydoc IScaleComponent::SetScale()
7299
7188
  */
7300
7189
  setScale(value: Common.Vector3): void;
7301
7190
  /**
7191
+ @copydoc ITransformComponent::GetTransform()
7192
+ */
7193
+ getTransform(): Multiplayer.SpaceTransform;
7194
+ /**
7195
+ @copydoc ITransformComonent::SetTransform()
7196
+ */
7197
+ setTransform(value: Multiplayer.SpaceTransform): void;
7198
+ /**
7199
+ @}
7302
7200
  * @description Gets the billboard mode used by this image component.
7303
7201
  * @return The billboard mode used by this image component.
7304
7202
  */
@@ -7354,7 +7252,7 @@ export declare namespace Multiplayer {
7354
7252
  @ingroup LightSpaceComponent
7355
7253
  * @description Data representation of an LightSpaceComponent.
7356
7254
  */
7357
- class LightSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IVisibleComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
7255
+ class LightSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, Multiplayer.IRotationComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.IVisibleComponent, INativeResource {
7358
7256
  /** @internal */
7359
7257
  constructor(pointer: NativePointer);
7360
7258
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.LightSpaceComponent;
@@ -7434,50 +7332,28 @@ export declare namespace Multiplayer {
7434
7332
  */
7435
7333
  setOuterConeAngle(value: number): void;
7436
7334
  /**
7437
- * @description Gets the position of the origin of this component in world space.
7438
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
7439
- * - Right handed coordinate system
7440
- * - +Y is UP
7441
- * - +X is left (facing forward)
7442
- * - +Z is forward
7443
- * @return The 3D position as vector (left, up, forward) in meters.
7335
+ * \addtogroup IPositionComponent
7336
+ @{
7337
+ @copydoc IPositionComponent::GetPosition()
7444
7338
  */
7445
7339
  getPosition(): Common.Vector3;
7446
7340
  /**
7447
- * @description Sets the position of the origin of this component in world space.
7448
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
7449
- * - Right handed coordinate system
7450
- * - +Y is UP
7451
- * - +X is left (facing forward)
7452
- * - +Z is forward
7341
+ @copydoc IPositionComponent::SetPosition()
7453
7342
  */
7454
7343
  setPosition(value: Common.Vector3): void;
7455
7344
  /**
7456
- * @description Gets a quaternion representing the rotation of the origin of this component, expressed in radians.
7457
- * NOTE: The coordinate system respects the following conventions:
7458
- * - Right handed coordinate system
7459
- * - Positive rotation is counterclockwise
7460
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
7461
- * - North: +Z
7462
- * - East: -X
7463
- * - South: -Z
7464
- * - West: +X
7345
+ @}
7346
+ * \addtogroup IRotationComponent
7347
+ @{
7348
+ @copydoc IRotationComponent::GetRotation()
7465
7349
  */
7466
7350
  getRotation(): Common.Vector4;
7467
7351
  /**
7468
- * @description Sets the rotation of the origin of this component according to the specified quaternion "Value", expressed in radians.
7469
- * NOTE: The coordinate system respects the following conventions:
7470
- * - Right handed coordinate system
7471
- * - Positive rotation is counterclockwise
7472
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
7473
- * - North: +Z
7474
- * - East: -X
7475
- * - South: -Z
7476
- * - West: +X
7477
- * @param value - The quaternion in radians to use as new rotation of this component.
7352
+ @copydoc IRotationComponent::SetRotation()
7478
7353
  */
7479
7354
  setRotation(value: Common.Vector4): void;
7480
7355
  /**
7356
+ @}
7481
7357
  * @description Gets the ID of the asset used for the light cookie of this light component.
7482
7358
  * @return The ID of the asset used for the light cookie of this light component.
7483
7359
  */
@@ -7540,7 +7416,7 @@ export declare namespace Multiplayer {
7540
7416
  }
7541
7417
  }
7542
7418
  export declare namespace Multiplayer {
7543
- class PortalSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, INativeResource {
7419
+ class PortalSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.IPositionComponent, INativeResource {
7544
7420
  /** @internal */
7545
7421
  constructor(pointer: NativePointer);
7546
7422
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.PortalSpaceComponent;
@@ -7564,25 +7440,17 @@ export declare namespace Multiplayer {
7564
7440
  */
7565
7441
  setSpaceId(value: string): void;
7566
7442
  /**
7567
- * @description Gets the position of the origin of this component in world space.
7568
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
7569
- * - Right handed coordinate system
7570
- * - +Y is UP
7571
- * - +X is left (facing forward)
7572
- * - +Z is forward
7573
- * @return The 3D position as vector (left, up, forward) in meters.
7443
+ * \addtogroup IPositionComponent
7444
+ @{
7445
+ @copydoc IPositionComponent::GetPosition()
7574
7446
  */
7575
7447
  getPosition(): Common.Vector3;
7576
7448
  /**
7577
- * @description Sets the position of the origin of this component in world space.
7578
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
7579
- * - Right handed coordinate system
7580
- * - +Y is UP
7581
- * - +X is left (facing forward)
7582
- * - +Z is forward
7449
+ @copydoc IPositionComponent::SetPosition()
7583
7450
  */
7584
7451
  setPosition(value: Common.Vector3): void;
7585
7452
  /**
7453
+ @}
7586
7454
  * @description Gets the radius of this portal.
7587
7455
  * @return The radius of this portal.
7588
7456
  */
@@ -7618,7 +7486,7 @@ export declare namespace Multiplayer {
7618
7486
  @ingroup ReflectionSpaceComponent
7619
7487
  * @description Data representation of an ReflectionSpaceComponent.
7620
7488
  */
7621
- class ReflectionSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IThirdPartyComponentRef, INativeResource {
7489
+ class ReflectionSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, Multiplayer.IScaleComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
7622
7490
  /** @internal */
7623
7491
  constructor(pointer: NativePointer);
7624
7492
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.ReflectionSpaceComponent;
@@ -7659,31 +7527,28 @@ export declare namespace Multiplayer {
7659
7527
  */
7660
7528
  setAssetCollectionId(value: string): void;
7661
7529
  /**
7662
- * @description Position of the Reflection component.
7530
+ * \addtogroup IPositionComponent
7531
+ @{
7532
+ @copydoc IPositionComponent::GetPosition()
7663
7533
  */
7664
7534
  getPosition(): Common.Vector3;
7665
7535
  /**
7666
- * @description Set the position of the Reflection component.
7667
- * @param value - Position of the Reflection Component.
7536
+ @copydoc IPositionComponent::SetPosition()
7668
7537
  */
7669
7538
  setPosition(value: Common.Vector3): void;
7670
7539
  /**
7671
- * @description Rotation of the Reflection component.
7672
- * @return Will return an Identity Quaternion (0, 0, 0, 1).
7673
- */
7674
- getRotation(): Common.Vector4;
7675
- /**
7676
- * @description Scale of the Reflection components spatial extents over which the reflection should apply.
7677
- * UnitBox/Sphere * Scale == Spatial Extents.
7540
+ @}
7541
+ * \addtogroup IScaleComponent
7542
+ @{
7543
+ @copydoc IScaleComponent::GetScale()
7678
7544
  */
7679
7545
  getScale(): Common.Vector3;
7680
7546
  /**
7681
- * @description Set the scale of the Reflection components spatial extents.
7682
- * @param value - Scale extents of the Reflection Component.
7683
- * UnitBox/Sphere * Scale == Spatial Extents.
7547
+ @copydoc IScaleComponent::SetScale()
7684
7548
  */
7685
7549
  setScale(value: Common.Vector3): void;
7686
7550
  /**
7551
+ @}
7687
7552
  * @description Get the reflection shape enum value.
7688
7553
  * ReflectionShape.UnitBox: Projects a texture in a planar fashion from all six directions (like an inward facing cube).
7689
7554
  * ReflectionShape.UnitSphere: Warps the texture into a spherical shape and projects it onto a surface.
@@ -7794,7 +7659,7 @@ export declare namespace Multiplayer {
7794
7659
  @ingroup StaticModelSpaceComponent
7795
7660
  * @description Data representation of an StaticModelSpaceComponent.
7796
7661
  */
7797
- class StaticModelSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, Multiplayer.IExternalResourceComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.IShadowCasterComponent, INativeResource {
7662
+ class StaticModelSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IExternalResourceComponent, Multiplayer.IShadowCasterComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
7798
7663
  /** @internal */
7799
7664
  constructor(pointer: NativePointer);
7800
7665
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.StaticModelSpaceComponent;
@@ -7803,7 +7668,13 @@ export declare namespace Multiplayer {
7803
7668
  * @param parent - The Space entity that owns this component.
7804
7669
  */
7805
7670
  static create_parent(parent: Multiplayer.SpaceEntity): StaticModelSpaceComponent;
7671
+ /** @deprecated
7672
+ Due to the introduction of LODs it doesn't make sense to set a specific asset anymore
7673
+ */
7806
7674
  getExternalResourceAssetId(): string;
7675
+ /** @deprecated
7676
+ Due to the introduction of LODs it doesn't make sense to set a specific asset anymore
7677
+ */
7807
7678
  setExternalResourceAssetId(value: string): void;
7808
7679
  /**
7809
7680
  * @description Gets the ID of the asset collection associated with this component.
@@ -7900,7 +7771,7 @@ export declare namespace Multiplayer {
7900
7771
  @ingroup VideoPlayerSpaceComponent
7901
7772
  * @description Data representation of an VideoPlayerSpaceComponent.
7902
7773
  */
7903
- class VideoPlayerSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IVisibleComponent, Multiplayer.IEnableableComponent, INativeResource {
7774
+ class VideoPlayerSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
7904
7775
  /** @internal */
7905
7776
  constructor(pointer: NativePointer);
7906
7777
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.VideoPlayerSpaceComponent;
@@ -7952,70 +7823,41 @@ export declare namespace Multiplayer {
7952
7823
  */
7953
7824
  setAssetCollectionId(value: string): void;
7954
7825
  /**
7955
- * @description Gets the position of the origin of this component in world space.
7956
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
7957
- * - Right handed coordinate system
7958
- * - +Y is UP
7959
- * - +X is left (facing forward)
7960
- * - +Z is forward
7961
- * @return The 3D position as vector (left, up, forward) in meters.
7826
+ * \addtogroup ITransformComponent
7827
+ @{
7828
+ @copydoc IPositionComponent::GetPosition()
7962
7829
  */
7963
7830
  getPosition(): Common.Vector3;
7964
7831
  /**
7965
- * @description Sets the position of the origin of this component in world space.
7966
- * NOTE: The coordinate system used follows the glTF 2.0 specification, in meters.
7967
- * - Right handed coordinate system
7968
- * - +Y is UP
7969
- * - +X is left (facing forward)
7970
- * - +Z is forward
7832
+ @copydoc IPositionComponent::SetPosition()
7971
7833
  */
7972
7834
  setPosition(value: Common.Vector3): void;
7973
7835
  /**
7974
- * @description Gets a quaternion representing the rotation of the origin of this component, expressed in radians.
7975
- * NOTE: The coordinate system respects the following conventions:
7976
- * - Right handed coordinate system
7977
- * - Positive rotation is counterclockwise
7978
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
7979
- * - North: +Z
7980
- * - East: -X
7981
- * - South: -Z
7982
- * - West: +X
7836
+ @copydoc IRotationComponent::GetRotation()
7983
7837
  */
7984
7838
  getRotation(): Common.Vector4;
7985
7839
  /**
7986
- * @description Sets the rotation of the origin of this component according to the specified quaternion "Value", expressed in radians.
7987
- * NOTE: The coordinate system respects the following conventions:
7988
- * - Right handed coordinate system
7989
- * - Positive rotation is counterclockwise
7990
- * - The geographic North is along the positive Z axis (+Z) at an orientation of 0 degrees.
7991
- * - North: +Z
7992
- * - East: -X
7993
- * - South: -Z
7994
- * - West: +X
7995
- * @param value - The quaternion in radians to use as new rotation of this component.
7840
+ @copydoc IRotationComponent::SetRotation()
7996
7841
  */
7997
7842
  setRotation(value: Common.Vector4): void;
7998
7843
  /**
7999
- * @description Gets the scale of the origin of this component in world space.
8000
- * NOTE: The coordinate system used follows the glTF 2.0 specification.
8001
- * - Right handed coordinate system
8002
- * - +Y is UP
8003
- * - +X is left (facing forward)
8004
- * - +Z is forward
8005
- * @return The 3D scale as vector (left, up, forward).
7844
+ @copydoc IScaleComponent::GetScale()
8006
7845
  */
8007
7846
  getScale(): Common.Vector3;
8008
7847
  /**
8009
- * @description Sets the scale of the origin of this component in world space to the specified "Value".
8010
- * @param value - The new value expressed as vector (left, up, forward).
8011
- * NOTE: The coordinate system used follows the glTF 2.0 specification.
8012
- * - Right handed coordinate system
8013
- * - +Y is UP
8014
- * - +X is left (facing forward)
8015
- * - +Z is forward
7848
+ @copydoc IScaleComponent::SetScale()
8016
7849
  */
8017
7850
  setScale(value: Common.Vector3): void;
8018
7851
  /**
7852
+ @copydoc ITransformComponent::GetTransform()
7853
+ */
7854
+ getTransform(): Multiplayer.SpaceTransform;
7855
+ /**
7856
+ @copydoc ITransformComonent::SetTransform()
7857
+ */
7858
+ setTransform(value: Multiplayer.SpaceTransform): void;
7859
+ /**
7860
+ @}
8019
7861
  * @description Checks if the playback state of this video player needs to be shared with other users through replication.
8020
7862
  * @return True if the playback state of the video needs to be shared among all users, false otherwise.
8021
7863
  */
@@ -8375,6 +8217,7 @@ export declare namespace Systems {
8375
8217
  * @return Uri of the uploaded asset.
8376
8218
  */
8377
8219
  getUri(): string;
8220
+ setUri(value: string): void;
8378
8221
  delete(): void;
8379
8222
  }
8380
8223
  }
@@ -8466,6 +8309,16 @@ export declare namespace Systems {
8466
8309
  * @param callback - Callback when asynchronous task finishes
8467
8310
  */
8468
8311
  deleteAssetCollection(assetCollection: Systems.AssetCollection): Promise<Systems.NullResult>;
8312
+ /**
8313
+ * @description Copies an array of asset collections to another space. Note that all source asset collections must belong to the same space.
8314
+ * @param sourceAssetCollections - The array of asset collections to copy. They must all belong to the same
8315
+ * space.
8316
+ * @param destSpaceId - The unique identifier of the space to copy these asset collections to.
8317
+ * @param copyAsync - Whether to instruct the services to perform the copy of the asset collections
8318
+ * asynchronously.
8319
+ * @param callback - Callback when asynchronous task finishes
8320
+ */
8321
+ copyAssetCollectionsToSpace(sourceAssetCollections: Common.Array<Systems.AssetCollection>, destSpaceId: string, copyAsync: boolean): Promise<Systems.AssetCollectionsResult>;
8469
8322
  /**
8470
8323
  * @description Finds an asset collection by its Id.
8471
8324
  * @param assetCollectionId - Asset collection to delete
@@ -8478,12 +8331,6 @@ export declare namespace Systems {
8478
8331
  * @param callback - Callback when asynchronous task finishes
8479
8332
  */
8480
8333
  getAssetCollectionByName(assetCollectionName: string): Promise<Systems.AssetCollectionResult>;
8481
- /**
8482
- * @description Finds a collection of asset collections by their Ids.
8483
- * @param assetCollectionIds - An array of ids to search for
8484
- * @param callback - Callback when asynchronous task finishes
8485
- */
8486
- getAssetCollectionsByIds(assetCollectionIds: Common.Array<string>): Promise<Systems.AssetCollectionsResult>;
8487
8334
  /**
8488
8335
  * @description Retrieves asset collections based on the specified search criteria.
8489
8336
  * Results pagination is supported through the use of ResultsSkipNumber and ResultsMaxNumber.
@@ -8499,7 +8346,7 @@ export declare namespace Systems {
8499
8346
  * entries pass nullptr.
8500
8347
  * @param callback - Callback when asynchronous task finishes
8501
8348
  */
8502
- getAssetCollectionsByCriteria(spaceId: string | null, assetCollectionParentId: string | null, assetCollectionType: Systems.EAssetCollectionType | null, assetCollectionTags: Common.Array<string> | null, assetCollectionNames: Common.Array<string> | null, resultsSkipNumber: number | null, resultsMaxNumber: number | null): Promise<Systems.AssetCollectionsResult>;
8349
+ findAssetCollections(ids: Common.Array<string> | null, parentId: string | null, names: Common.Array<string> | null, types: Common.Array<Systems.EAssetCollectionType> | null, tags: Common.Array<string> | null, spaceIds: Common.Array<string> | null, resultsSkipNumber: number | null, resultsMaxNumber: number | null): Promise<Systems.AssetCollectionsResult>;
8503
8350
  /**
8504
8351
  * @description Updates the Metadata field of an Asset Collection
8505
8352
  * @param assetCollection - Asset collection to be updated
@@ -8709,7 +8556,6 @@ export declare namespace Systems {
8709
8556
  /** @internal */
8710
8557
  constructor(pointer: NativePointer);
8711
8558
  static fromSystemBase(baseInstance: Systems.SystemBase): Systems.ECommerceSystem;
8712
- static create(): ECommerceSystem;
8713
8559
  /**
8714
8560
  * @description Get product information from a shopify store within a space
8715
8561
  * @param spaceId - Space id of product
@@ -8963,9 +8809,6 @@ export declare namespace Systems {
8963
8809
  /** @internal */
8964
8810
  constructor(pointer: NativePointer);
8965
8811
  static fromResultBase(baseInstance: Systems.ResultBase): Systems.MaintenanceInfoResult;
8966
- static create(): MaintenanceInfoResult;
8967
- static create_arg1(arg1: number): MaintenanceInfoResult;
8968
- static create_resCode_httpResCode(resCode: Systems.EResultCode, httpResCode: number): MaintenanceInfoResult;
8969
8812
  /**
8970
8813
  * @description Retrieves response data from the Maintenance Window Server
8971
8814
  * @return Return all maintenance information available in date order
@@ -9169,6 +9012,22 @@ export declare namespace Systems {
9169
9012
  delete(): void;
9170
9013
  }
9171
9014
  }
9015
+ export declare namespace Systems {
9016
+ /**
9017
+ * @description A result handler that is used to notify a user of an error while passing a String value.
9018
+ */
9019
+ class AvatarInfoResult extends Systems.ResultBase implements INativeResource {
9020
+ /** @internal */
9021
+ constructor(pointer: NativePointer);
9022
+ static fromResultBase(baseInstance: Systems.ResultBase): Systems.AvatarInfoResult;
9023
+ /**
9024
+ * @description A getter which returns the String passed via the result.
9025
+ */
9026
+ getAvatarType(): Systems.AvatarType;
9027
+ getAvatarIdentifier(): Common.Variant;
9028
+ delete(): void;
9029
+ }
9030
+ }
9172
9031
  export declare namespace Systems {
9173
9032
  /**
9174
9033
  @ingroup Settings System
@@ -9185,24 +9044,24 @@ export declare namespace Systems {
9185
9044
  * @param inValue - Boolean reflecting desired state to store in magnopus connected services.
9186
9045
  * @param callback - Callback when asynchronous task finishes.
9187
9046
  */
9188
- setNDAStatus(userId: string, value: boolean): Promise<Systems.NullResult>;
9047
+ setNDAStatus(value: boolean): Promise<Systems.NullResult>;
9189
9048
  /**
9190
9049
  * @description Get a boolean indicating whether the current user has completed a non-disclosure agreement.
9191
9050
  * @param callback - Callback to call when a response is received.
9192
9051
  */
9193
- getNDAStatus(userId: string): Promise<Systems.BooleanResult>;
9052
+ getNDAStatus(): Promise<Systems.BooleanResult>;
9194
9053
  /**
9195
9054
  * @description Opt in or out to receiving a newsletter for the current user.
9196
9055
  * NullResultCallback. Returns status of the update task, no payload expected.
9197
9056
  * @param inValue - Boolean reflecting desired state to store in magnopus connected services
9198
9057
  * @param callback - Callback when asynchronous task finishes
9199
9058
  */
9200
- setNewsletterStatus(userId: string, value: boolean): Promise<Systems.NullResult>;
9059
+ setNewsletterStatus(value: boolean): Promise<Systems.NullResult>;
9201
9060
  /**
9202
9061
  * @description Get a boolean indicating whether the current user has opted into receiving a newsletter.
9203
9062
  * @param callback - Callback to call when a response is received.
9204
9063
  */
9205
- getNewsletterStatus(userId: string): Promise<Systems.BooleanResult>;
9064
+ getNewsletterStatus(): Promise<Systems.BooleanResult>;
9206
9065
  /**
9207
9066
  * @description Add a Space to the current user's list of recently visited Spaces
9208
9067
  * Supplying a SpaceID will store as the most recent space, manages the list order and storing to Magnopus Connected Services.
@@ -9210,18 +9069,18 @@ export declare namespace Systems {
9210
9069
  * @param inSpaceID - SpaceID of most recent space entered
9211
9070
  * @param callback - Callback when asynchronous task finishes
9212
9071
  */
9213
- addRecentlyVisitedSpace(userId: string, spaceID: string): Promise<Systems.NullResult>;
9072
+ addRecentlyVisitedSpace(spaceID: string): Promise<Systems.NullResult>;
9214
9073
  /**
9215
9074
  * @description Get an array of the most recently visited Spaces for the current user.
9216
9075
  * Returns an csp::common::Array of csp::common::Strings ordered from most to least recent spaces up to a maximum of 10 entries.
9217
9076
  * @param callback - Callback to call when a response is received.
9218
9077
  */
9219
- getRecentlyVisitedSpaces(userId: string): Promise<Systems.StringArrayResult>;
9078
+ getRecentlyVisitedSpaces(): Promise<Systems.StringArrayResult>;
9220
9079
  /**
9221
9080
  * @description Clear the list of recently-visited spaces for the current user.
9222
9081
  * @param callback - Callback when asynchronous task finishes.
9223
9082
  */
9224
- clearRecentlyVisitedSpaces(userId: string): Promise<Systems.NullResult>;
9083
+ clearRecentlyVisitedSpaces(): Promise<Systems.NullResult>;
9225
9084
  /**
9226
9085
  * @description Block a space for the current user.
9227
9086
  * The client is expected to implement the actual space filtering functionality as this function only adds the provided space to a list and will
@@ -9229,46 +9088,55 @@ export declare namespace Systems {
9229
9088
  * @param inSpaceID - SpaceID of most space to block
9230
9089
  * @param callback - Callback when asynchronous task finishes
9231
9090
  */
9232
- addBlockedSpace(userId: string, spaceID: string): Promise<Systems.NullResult>;
9091
+ addBlockedSpace(spaceID: string): Promise<Systems.NullResult>;
9233
9092
  /**
9234
9093
  * @description Unblock a space for the current user.
9235
9094
  * @param inSpaceID - SpaceID of most space to block
9236
9095
  * @param callback - Callback when asynchronous task finishes
9237
9096
  */
9238
- removeBlockedSpace(userId: string, spaceID: string): Promise<Systems.NullResult>;
9097
+ removeBlockedSpace(spaceID: string): Promise<Systems.NullResult>;
9239
9098
  /**
9240
9099
  * @description Get a list of Spaces that were blocked by the current user.
9241
9100
  * Returns an csp::common::Array of csp::common::Strings ordered from most to least recent blocked spaces.
9242
9101
  * @param callback - Callback to call when a response is received.
9243
9102
  */
9244
- getBlockedSpaces(userId: string): Promise<Systems.StringArrayResult>;
9103
+ getBlockedSpaces(): Promise<Systems.StringArrayResult>;
9245
9104
  /**
9246
9105
  * @description Clear the list of blocked Spaces for the current user.
9247
9106
  * @param callback - Callback when asynchronous task finishes.
9248
9107
  */
9249
- clearBlockedSpaces(userId: string): Promise<Systems.NullResult>;
9108
+ clearBlockedSpaces(): Promise<Systems.NullResult>;
9250
9109
  /**
9251
9110
  * @description Updates the Portrait Avatar image or adds one if it didn't have it previously using FileAssetDataSource
9252
- * @param userId - UserId of Avatar Portrait
9253
9111
  * @param newAvatarPortrait - New Portrait Avatar information
9254
9112
  * @param callback - Callback when asynchronous task finishes
9255
9113
  */
9256
- updateAvatarPortrait(userId: string, newAvatarPortrait: Systems.FileAssetDataSource): Promise<Systems.NullResult>;
9114
+ updateAvatarPortrait(newAvatarPortrait: Systems.FileAssetDataSource): Promise<Systems.NullResult>;
9257
9115
  /**
9258
9116
  * @description Retrieves the Avatar Portrait information associated with the space
9259
9117
  * If the user of the Avatar portrait associated with it the result callback will be successful, the HTTP res code will be ResponseNotFound
9260
9118
  * and the Uri field inside the UriResult will be empty
9261
- * @param userId - UserId of Avatar Portrait
9262
9119
  * @param callback - Callback when asynchronous task finishes
9263
9120
  */
9264
- getAvatarPortrait(userId: string): Promise<Systems.UriResult>;
9121
+ getAvatarPortrait(): Promise<Systems.UriResult>;
9265
9122
  /**
9266
9123
  * @description Updates the Avatar Portrait image or adds one if it didn't have it previously using BufferAssetDataSource
9267
- * @param userId - UserId of Avatar Portrait
9268
9124
  * @param newAvatarPortrait - New Avatar Portrait information
9269
9125
  * @param callback - Callback when asynchronous task finishes
9270
9126
  */
9271
- updateAvatarPortraitWithBuffer(userId: string, newAvatarPortrait: Systems.BufferAssetDataSource): Promise<Systems.NullResult>;
9127
+ updateAvatarPortraitWithBuffer(newAvatarPortrait: Systems.BufferAssetDataSource): Promise<Systems.NullResult>;
9128
+ /**
9129
+ * @description Sets the avatar type and identifier for a user.
9130
+ * @param inType - The type of avatar (predefined, Ready Player Me, or custom).
9131
+ * @param inIdentifier - A value used to identify or locate the avatar. Differs depending on the value of InType.
9132
+ * @param callback - Callback to call when task finishes.
9133
+ */
9134
+ setAvatarInfo(type: Systems.AvatarType, identifier: Common.Variant): Promise<Systems.NullResult>;
9135
+ /**
9136
+ * @description Retrieves the avatar type and identifier for a user.
9137
+ * @param callback - Callback to call when task finishes.
9138
+ */
9139
+ getAvatarInfo(): Promise<Systems.AvatarInfoResult>;
9272
9140
  }
9273
9141
  }
9274
9142
  export declare namespace Systems {
@@ -9970,83 +9838,19 @@ export declare namespace Systems {
9970
9838
  delete(): void;
9971
9839
  }
9972
9840
  }
9973
- export declare namespace Systems {
9974
- /**
9975
- * @description Result structure for a logout state request.
9976
- */
9977
- class LogoutResult extends Systems.NullResult implements INativeResource {
9978
- /** @internal */
9979
- constructor(pointer: NativePointer);
9980
- static fromNullResult(baseInstance: Systems.NullResult): Systems.LogoutResult;
9981
- delete(): void;
9982
- }
9983
- }
9984
9841
  export declare namespace Systems {
9985
9842
  /**
9986
9843
  @ingroup User System
9987
9844
  * @description @brief Data class used to contain information when the login token has changed
9988
9845
  */
9989
- class LoginTokenReceived extends Systems.ResultBase implements INativeResource {
9846
+ class LoginTokenInfoResult extends Systems.ResultBase implements INativeResource {
9990
9847
  /** @internal */
9991
9848
  constructor(pointer: NativePointer);
9992
- static fromResultBase(baseInstance: Systems.ResultBase): Systems.LoginTokenReceived;
9849
+ static fromResultBase(baseInstance: Systems.ResultBase): Systems.LoginTokenInfoResult;
9993
9850
  getLoginTokenInfo(): Systems.LoginTokenInfo;
9994
9851
  delete(): void;
9995
9852
  }
9996
9853
  }
9997
- export declare namespace Systems {
9998
- /**
9999
- @ingroup User System
10000
- * @description @brief Data class used to contain information when a ping response is received
10001
- */
10002
- class PingResponseReceived extends Systems.ResultBase implements INativeResource {
10003
- /** @internal */
10004
- constructor(pointer: NativePointer);
10005
- static fromResultBase(baseInstance: Systems.ResultBase): Systems.PingResponseReceived;
10006
- delete(): void;
10007
- }
10008
- }
10009
- export declare namespace Systems {
10010
- /**
10011
- @ingroup User System
10012
- * @description @brief Data class used to contain information requesting a user token
10013
- */
10014
- class AgoraUserTokenResult extends Systems.ResultBase implements INativeResource {
10015
- /** @internal */
10016
- constructor(pointer: NativePointer);
10017
- static fromResultBase(baseInstance: Systems.ResultBase): Systems.AgoraUserTokenResult;
10018
- getUserToken(): string;
10019
- delete(): void;
10020
- }
10021
- }
10022
- export declare namespace Systems {
10023
- /**
10024
- * @description Result url for a tier checkout session request
10025
- */
10026
- class CheckoutSessionUrlResult extends Systems.ResultBase implements INativeResource {
10027
- /** @internal */
10028
- constructor(pointer: NativePointer);
10029
- static fromResultBase(baseInstance: Systems.ResultBase): Systems.CheckoutSessionUrlResult;
10030
- static create(): CheckoutSessionUrlResult;
10031
- static create_arg1(arg1: number): CheckoutSessionUrlResult;
10032
- getUrl(): string;
10033
- delete(): void;
10034
- }
10035
- }
10036
- export declare namespace Systems {
10037
- /**
10038
- * @description Result url for a user customer portal request
10039
- */
10040
- class CustomerPortalUrlResult extends Systems.ResultBase implements INativeResource {
10041
- /** @internal */
10042
- constructor(pointer: NativePointer);
10043
- static fromResultBase(baseInstance: Systems.ResultBase): Systems.CustomerPortalUrlResult;
10044
- static create(): CustomerPortalUrlResult;
10045
- static create_arg1(arg1: number): CustomerPortalUrlResult;
10046
- getUrl(): string;
10047
- delete(): void;
10048
- }
10049
- }
10050
9854
  export declare namespace Systems {
10051
9855
  /**
10052
9856
  * @description Data structure for a full user profile, which incudes user email, roles, and data for creation and update history.
@@ -10136,7 +9940,7 @@ export declare namespace Systems {
10136
9940
  * For C#: register a callback to the OnNewLoginTokenReceived event
10137
9941
  * @param callback - Callback that gets called as described above
10138
9942
  */
10139
- setNewLoginTokenReceivedCallback(callback: (result: Systems.LoginTokenReceived) => void): void;
9943
+ setNewLoginTokenReceivedCallback(callback: (result: Systems.LoginTokenInfoResult) => void): void;
10140
9944
  /**
10141
9945
  * @description Log in to Magnopus Connected Services services using a username-password or email-password combination.
10142
9946
  * @param userName - Csp::common::string
@@ -10147,14 +9951,13 @@ export declare namespace Systems {
10147
9951
  */
10148
9952
  login(userName: string, email: string, password: string, userHasVerifiedAge: boolean | null): Promise<Systems.LoginStateResult>;
10149
9953
  /**
10150
- * @description Log in to Magnopus Connected Services using a login token
10151
- * The login token can be obtained after using the Login API with credentials and having registered a callback through
10152
- * SetNewLoginTokenReceivedCallback. If the login is successful in the callback result the token and it's expiration time will be provided.
10153
- * @param userId - The user id associated with this login token
10154
- * @param loginToken - Token to be used for authenticating
9954
+ * @description Resume a previous session for the associated user ID using a refresh token
9955
+ * The refresh token can be obtained after registering a callback with `SetNewLoginTokenReceivedCallback` and logging in regularly.
9956
+ * @param userId - User ID for the previous session
9957
+ * @param refreshToken - Refresh token to be used for refreshing the authentication token
10155
9958
  * @param callback - Callback when asynchronous task finishes
10156
9959
  */
10157
- loginWithToken(userId: string, loginToken: string): Promise<Systems.LoginStateResult>;
9960
+ refreshSession(userId: string, refreshToken: string): Promise<Systems.LoginStateResult>;
10158
9961
  /**
10159
9962
  * @description Log in to Magnopus Connected Services as a guest.
10160
9963
  * @param userHasVerifiedAge - An optional bool to specify whether or not the user has verified that they are over 18
@@ -10200,7 +10003,7 @@ export declare namespace Systems {
10200
10003
  * @description Logout from Magnopus Connected Services.
10201
10004
  * @param callback - Callback to call when a response is received
10202
10005
  */
10203
- logout(): Promise<Systems.LogoutResult>;
10006
+ logout(): Promise<Systems.NullResult>;
10204
10007
  /**
10205
10008
  * @description Creates a new user profile.
10206
10009
  * @param userName - User name associated with the new profile
@@ -10244,7 +10047,7 @@ export declare namespace Systems {
10244
10047
  */
10245
10048
  updateUserDisplayName(userId: string, newUserDisplayName: string): Promise<Systems.NullResult>;
10246
10049
  /**
10247
- * @description Delete the user.
10050
+ * @description Delete the user. Note that you need permission to be able to delete the user (You can delete the user you are logged in as).
10248
10051
  * @param userId - Id of the user that will be deleted
10249
10052
  * @param callback - Callback when asynchronous task finishes
10250
10053
  */
@@ -10274,13 +10077,13 @@ export declare namespace Systems {
10274
10077
  * @description Ping Magnopus Connected Services
10275
10078
  * @param callback - Callback to call when a response is received
10276
10079
  */
10277
- ping(): Promise<Systems.PingResponseReceived>;
10080
+ ping(): Promise<Systems.NullResult>;
10278
10081
  /**
10279
10082
  * @description Retrieve User token from Agora
10280
10083
  * @param params - Params to configure the User token
10281
10084
  * @param callback - Callback to call when a response is received
10282
10085
  */
10283
- getAgoraUserToken(params: Systems.AgoraUserTokenParams): Promise<Systems.AgoraUserTokenResult>;
10086
+ getAgoraUserToken(params: Systems.AgoraUserTokenParams): Promise<Systems.StringResult>;
10284
10087
  /**
10285
10088
  * @description Re-send user verification email
10286
10089
  * @param inEmail - User's email address
@@ -10293,13 +10096,13 @@ export declare namespace Systems {
10293
10096
  * @param userId - The id of the user associated with the customer portal
10294
10097
  * @param callback - Callback that contains the customer portal url of the user
10295
10098
  */
10296
- getCustomerPortalUrl(userId: string): Promise<Systems.CustomerPortalUrlResult>;
10099
+ getCustomerPortalUrl(userId: string): Promise<Systems.StringResult>;
10297
10100
  /**
10298
10101
  * @description Get the checkout session Url for a user from Stripe
10299
10102
  * @param tier - The tier of the checkout session needed
10300
10103
  * @param callback - Callback that contains the checkout session url of the tier
10301
10104
  */
10302
- getCheckoutSessionUrl(tier: Systems.TierNames): Promise<Systems.CheckoutSessionUrlResult>;
10105
+ getCheckoutSessionUrl(tier: Systems.TierNames): Promise<Systems.StringResult>;
10303
10106
  }
10304
10107
  }
10305
10108
  export declare namespace Common {
@@ -10316,6 +10119,7 @@ export declare namespace Common {
10316
10119
  static ofcsp_systems_EAssetPlatform(): Array<Systems.EAssetPlatform>;
10317
10120
  static ofcsp_systems_Asset(): Array<Systems.Asset>;
10318
10121
  static ofcsp_systems_AssetCollection(): Array<Systems.AssetCollection>;
10122
+ static ofcsp_systems_EAssetCollectionType(): Array<Systems.EAssetCollectionType>;
10319
10123
  static ofcsp_systems_EAssetType(): Array<Systems.EAssetType>;
10320
10124
  static ofcsp_systems_LODAsset(): Array<Systems.LODAsset>;
10321
10125
  static ofcsp_systems_VariantOptionInfo(): Array<Systems.VariantOptionInfo>;
@@ -10350,6 +10154,7 @@ export declare namespace Common {
10350
10154
  static ofcsp_systems_EAssetPlatform_number(size: number): Array<Systems.EAssetPlatform>;
10351
10155
  static ofcsp_systems_Asset_number(size: number): Array<Systems.Asset>;
10352
10156
  static ofcsp_systems_AssetCollection_number(size: number): Array<Systems.AssetCollection>;
10157
+ static ofcsp_systems_EAssetCollectionType_number(size: number): Array<Systems.EAssetCollectionType>;
10353
10158
  static ofcsp_systems_EAssetType_number(size: number): Array<Systems.EAssetType>;
10354
10159
  static ofcsp_systems_LODAsset_number(size: number): Array<Systems.LODAsset>;
10355
10160
  static ofcsp_systems_VariantOptionInfo_number(size: number): Array<Systems.VariantOptionInfo>;