connected-spaces-platform.web 4.17.0 → 4.18.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
  /**
@@ -5153,6 +5168,25 @@ export declare namespace Systems {
5153
5168
  * @param level - The level to check.
5154
5169
  */
5155
5170
  loggingEnabled(level: Systems.LogLevel): boolean;
5171
+ /**
5172
+ * @description Log a message at a specific verbosity level.
5173
+ * @param level - The level to log this message at.
5174
+ * @param inMessage - The message to be logged.
5175
+ */
5176
+ logMsg(level: Systems.LogLevel, message: string): void;
5177
+ /**
5178
+ * @description Log an event.
5179
+ * @param inEvent - The event to be logged.
5180
+ */
5181
+ logEvent(event: string): void;
5182
+ /**
5183
+ * @description Specify a 'Marker' event which can be used to communicate a certain process occurring, usually for debugging.
5184
+ */
5185
+ beginMarker(marker: string): void;
5186
+ /**
5187
+ * @description End a 'Marker' event.
5188
+ */
5189
+ endMarker(): void;
5156
5190
  /**
5157
5191
  * @description Clears all logging callbacks.
5158
5192
  */
@@ -5701,7 +5735,13 @@ export declare namespace Multiplayer {
5701
5735
  * @param parent - The Space entity that owns this component.
5702
5736
  */
5703
5737
  static create_parent(parent: Multiplayer.SpaceEntity): AnimatedModelSpaceComponent;
5738
+ /** @deprecated
5739
+ Due to the introduction of LODs it doesn't make sense to set a specific asset anymore
5740
+ */
5704
5741
  getExternalResourceAssetId(): string;
5742
+ /** @deprecated
5743
+ Due to the introduction of LODs it doesn't make sense to set a specific asset anymore
5744
+ */
5705
5745
  setExternalResourceAssetId(value: string): void;
5706
5746
  /**
5707
5747
  * @description Gets the ID of the asset collection associated with this component.
@@ -5827,7 +5867,7 @@ export declare namespace Multiplayer {
5827
5867
  /**
5828
5868
  * @description Data representation of an AudioSpaceComponent.
5829
5869
  */
5830
- class AudioSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
5870
+ class AudioSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.IPositionComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
5831
5871
  /** @internal */
5832
5872
  constructor(pointer: NativePointer);
5833
5873
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.AudioSpaceComponent;
@@ -5837,25 +5877,17 @@ export declare namespace Multiplayer {
5837
5877
  */
5838
5878
  static create_parent(parent: Multiplayer.SpaceEntity): AudioSpaceComponent;
5839
5879
  /**
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.
5880
+ * \addtogroup IPositionComponent
5881
+ @{
5882
+ @copydoc IPositionComponent::GetPosition()
5847
5883
  */
5848
5884
  getPosition(): Common.Vector3;
5849
5885
  /**
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
5886
+ @copydoc IPositionComponent::SetPosition()
5856
5887
  */
5857
5888
  setPosition(value: Common.Vector3): void;
5858
5889
  /**
5890
+ @}
5859
5891
  * @description Gets the current playback state of the audio of this audio component.
5860
5892
  * @return The current playback state of the audio of this audio component.
5861
5893
  */
@@ -6200,7 +6232,7 @@ export declare namespace Multiplayer {
6200
6232
  @ingroup ButtonSpaceComponent
6201
6233
  * @description Data representation of an ButtonSpaceComponent.
6202
6234
  */
6203
- class ButtonSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.IVisibleComponent, INativeResource {
6235
+ class ButtonSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
6204
6236
  /** @internal */
6205
6237
  constructor(pointer: NativePointer);
6206
6238
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.ButtonSpaceComponent;
@@ -6244,70 +6276,41 @@ export declare namespace Multiplayer {
6244
6276
  */
6245
6277
  setAssetCollectionId(value: string): void;
6246
6278
  /**
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.
6279
+ * \addtogroup ITransformComponent
6280
+ @{
6281
+ @copydoc IPositionComponent::GetPosition()
6254
6282
  */
6255
6283
  getPosition(): Common.Vector3;
6256
6284
  /**
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
6285
+ @copydoc IPositionComponent::SetPosition()
6263
6286
  */
6264
6287
  setPosition(value: Common.Vector3): void;
6265
6288
  /**
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
6289
+ @copydoc IRotationComponent::GetRotation()
6275
6290
  */
6276
6291
  getRotation(): Common.Vector4;
6277
6292
  /**
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.
6293
+ @copydoc IRotationComponent::SetRotation()
6288
6294
  */
6289
6295
  setRotation(value: Common.Vector4): void;
6290
6296
  /**
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).
6297
+ @copydoc IScaleComponent::GetScale()
6298
6298
  */
6299
6299
  getScale(): Common.Vector3;
6300
6300
  /**
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
6301
+ @copydoc IScaleComponent::SetScale()
6308
6302
  */
6309
6303
  setScale(value: Common.Vector3): void;
6310
6304
  /**
6305
+ @copydoc ITransformComponent::GetTransform()
6306
+ */
6307
+ getTransform(): Multiplayer.SpaceTransform;
6308
+ /**
6309
+ @copydoc ITransformComonent::SetTransform()
6310
+ */
6311
+ setTransform(value: Multiplayer.SpaceTransform): void;
6312
+ /**
6313
+ @}
6311
6314
  * \addtogroup IClickableComponent
6312
6315
  @{
6313
6316
  @copydoc IClickableComponent::GetIsEnabled()
@@ -6344,7 +6347,7 @@ export declare namespace Multiplayer {
6344
6347
  @ingroup CollisionSpaceComponent
6345
6348
  * @description Data representation of an CollisionSpaceComponent.
6346
6349
  */
6347
- class CollisionSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IThirdPartyComponentRef, INativeResource {
6350
+ class CollisionSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, INativeResource {
6348
6351
  /** @internal */
6349
6352
  constructor(pointer: NativePointer);
6350
6353
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.CollisionSpaceComponent;
@@ -6354,70 +6357,41 @@ export declare namespace Multiplayer {
6354
6357
  */
6355
6358
  static create_parent(parent: Multiplayer.SpaceEntity): CollisionSpaceComponent;
6356
6359
  /**
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.
6360
+ * \addtogroup ITransformComponent
6361
+ @{
6362
+ @copydoc IPositionComponent::GetPosition()
6364
6363
  */
6365
6364
  getPosition(): Common.Vector3;
6366
6365
  /**
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
6366
+ @copydoc IPositionComponent::SetPosition()
6373
6367
  */
6374
6368
  setPosition(value: Common.Vector3): void;
6375
6369
  /**
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
6370
+ @copydoc IRotationComponent::GetRotation()
6385
6371
  */
6386
6372
  getRotation(): Common.Vector4;
6387
6373
  /**
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.
6374
+ @copydoc IRotationComponent::SetRotation()
6398
6375
  */
6399
6376
  setRotation(value: Common.Vector4): void;
6400
6377
  /**
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).
6378
+ @copydoc IScaleComponent::GetScale()
6408
6379
  */
6409
6380
  getScale(): Common.Vector3;
6410
6381
  /**
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
6382
+ @copydoc IScaleComponent::SetScale()
6418
6383
  */
6419
6384
  setScale(value: Common.Vector3): void;
6420
6385
  /**
6386
+ @copydoc ITransformComponent::GetTransform()
6387
+ */
6388
+ getTransform(): Multiplayer.SpaceTransform;
6389
+ /**
6390
+ @copydoc ITransformComonent::SetTransform()
6391
+ */
6392
+ setTransform(value: Multiplayer.SpaceTransform): void;
6393
+ /**
6394
+ @}
6421
6395
  * @description Gets the collision shape used by this collision component.
6422
6396
  * @return The colllision shape used by this collision component.
6423
6397
  */
@@ -6512,7 +6486,7 @@ export declare namespace Multiplayer {
6512
6486
  @ingroup ConversationSpaceComponent
6513
6487
  * @description Data representation of an ConversationSpaceComponent.
6514
6488
  */
6515
- class ConversationSpaceComponent extends Multiplayer.ComponentBase implements INativeResource {
6489
+ class ConversationSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, Multiplayer.IRotationComponent, INativeResource {
6516
6490
  /** @internal */
6517
6491
  constructor(pointer: NativePointer);
6518
6492
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.ConversationSpaceComponent;
@@ -6581,23 +6555,29 @@ export declare namespace Multiplayer {
6581
6555
  */
6582
6556
  setMessageInfo(messageId: string, messageData: Multiplayer.MessageInfo): Promise<Multiplayer.MessageResult>;
6583
6557
  /**
6584
- * @description Gets the relative 3D position of this component.
6558
+ * \addtogroup IPositionComponent
6559
+ @{
6560
+ @copydoc IPositionComponent::GetPosition()
6585
6561
  */
6586
6562
  getPosition(): Common.Vector3;
6587
6563
  /**
6588
- * @description Sets the relative 3D position of this component.
6589
- * @param value - - The new 3D position assigned to the origin of this component.
6564
+ @copydoc IPositionComponent::SetPosition()
6590
6565
  */
6591
6566
  setPosition(value: Common.Vector3): void;
6592
6567
  /**
6593
- * @description Gets the quaternion of the rotation of the origin of this component.
6568
+ @}
6569
+ * \addtogroup IRotationComponent
6570
+ @{
6571
+ @copydoc IRotationComponent::GetRotation()
6594
6572
  */
6595
6573
  getRotation(): Common.Vector4;
6596
6574
  /**
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.
6575
+ @copydoc IRotationComponent::SetRotation()
6599
6576
  */
6600
6577
  setRotation(value: Common.Vector4): void;
6578
+ /**
6579
+ @}
6580
+ */
6601
6581
  getIsVisible(): boolean;
6602
6582
  setIsVisible(value: boolean): void;
6603
6583
  getIsActive(): boolean;
@@ -6710,7 +6690,7 @@ export declare namespace Multiplayer {
6710
6690
  /**
6711
6691
  * @description Data representation of an ECommerceSpaceComponent.
6712
6692
  */
6713
- class ECommerceSpaceComponent extends Multiplayer.ComponentBase implements INativeResource {
6693
+ class ECommerceSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, INativeResource {
6714
6694
  /** @internal */
6715
6695
  constructor(pointer: NativePointer);
6716
6696
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.ECommerceSpaceComponent;
@@ -6720,25 +6700,17 @@ export declare namespace Multiplayer {
6720
6700
  */
6721
6701
  static create_parent(parent: Multiplayer.SpaceEntity): ECommerceSpaceComponent;
6722
6702
  /**
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.
6703
+ * \addtogroup ITransformComponent
6704
+ @{
6705
+ @copydoc IPositionComponent::GetPosition()
6730
6706
  */
6731
6707
  getPosition(): Common.Vector3;
6732
6708
  /**
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
6709
+ @copydoc IPositionComponent::SetPosition()
6739
6710
  */
6740
6711
  setPosition(value: Common.Vector3): void;
6741
6712
  /**
6713
+ @}
6742
6714
  * @description Gets the product ID associated with the ECommerce component.
6743
6715
  * @return The product ID associated with the ECommerce component.
6744
6716
  */
@@ -6757,7 +6729,7 @@ export declare namespace Multiplayer {
6757
6729
  * @description Data representation of an ExternalLinkSpaceComponent.
6758
6730
  * NOTE: This component can be used to handle external URLs that can be opened in game from a space.
6759
6731
  */
6760
- class ExternalLinkSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.IVisibleComponent, INativeResource {
6732
+ class ExternalLinkSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
6761
6733
  /** @internal */
6762
6734
  constructor(pointer: NativePointer);
6763
6735
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.ExternalLinkSpaceComponent;
@@ -6785,33 +6757,41 @@ export declare namespace Multiplayer {
6785
6757
  */
6786
6758
  setLinkUrl(value: string): void;
6787
6759
  /**
6788
- * @description Gets the 3D position in world coordinates where the origin of this component is located.
6760
+ * \addtogroup ITransformComponent
6761
+ @{
6762
+ @copydoc IPositionComponent::GetPosition()
6789
6763
  */
6790
6764
  getPosition(): Common.Vector3;
6791
6765
  /**
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.
6766
+ @copydoc IPositionComponent::SetPosition()
6794
6767
  */
6795
6768
  setPosition(value: Common.Vector3): void;
6796
6769
  /**
6797
- * @description Gets the quaternion of the rotation of the origin of this component.
6770
+ @copydoc IRotationComponent::GetRotation()
6798
6771
  */
6799
6772
  getRotation(): Common.Vector4;
6800
6773
  /**
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.
6774
+ @copydoc IRotationComponent::SetRotation()
6803
6775
  */
6804
6776
  setRotation(value: Common.Vector4): void;
6805
6777
  /**
6806
- * @description Gets the 3D scale of this component.
6778
+ @copydoc IScaleComponent::GetScale()
6807
6779
  */
6808
6780
  getScale(): Common.Vector3;
6809
6781
  /**
6810
- * @description Sets the 3D scale of this component.
6811
- * @param value - - The new 3D scale assigned to this component.
6782
+ @copydoc IScaleComponent::SetScale()
6812
6783
  */
6813
6784
  setScale(value: Common.Vector3): void;
6814
6785
  /**
6786
+ @copydoc ITransformComponent::GetTransform()
6787
+ */
6788
+ getTransform(): Multiplayer.SpaceTransform;
6789
+ /**
6790
+ @copydoc ITransformComonent::SetTransform()
6791
+ */
6792
+ setTransform(value: Multiplayer.SpaceTransform): void;
6793
+ /**
6794
+ @}
6815
6795
  * @description Gets the text that will be displayed by the component as hyperlink to the URL it redirects to.
6816
6796
  */
6817
6797
  getDisplayText(): string;
@@ -6857,7 +6837,7 @@ export declare namespace Multiplayer {
6857
6837
  @ingroup FiducialMarkerSpaceComponent
6858
6838
  * @description Data representation of a FiducialMarkerSpaceComponent.
6859
6839
  */
6860
- class FiducialMarkerSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IVisibleComponent, INativeResource {
6840
+ class FiducialMarkerSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
6861
6841
  /** @internal */
6862
6842
  constructor(pointer: NativePointer);
6863
6843
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.FiducialMarkerSpaceComponent;
@@ -6899,70 +6879,41 @@ export declare namespace Multiplayer {
6899
6879
  */
6900
6880
  setAssetCollectionId(value: string): void;
6901
6881
  /**
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.
6882
+ * \addtogroup ITransformComponent
6883
+ @{
6884
+ @copydoc IPositionComponent::GetPosition()
6909
6885
  */
6910
6886
  getPosition(): Common.Vector3;
6911
6887
  /**
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
6888
+ @copydoc IPositionComponent::SetPosition()
6918
6889
  */
6919
6890
  setPosition(value: Common.Vector3): void;
6920
6891
  /**
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
6892
+ @copydoc IRotationComponent::GetRotation()
6930
6893
  */
6931
6894
  getRotation(): Common.Vector4;
6932
6895
  /**
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.
6896
+ @copydoc IRotationComponent::SetRotation()
6943
6897
  */
6944
6898
  setRotation(value: Common.Vector4): void;
6945
6899
  /**
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).
6900
+ @copydoc IScaleComponent::GetScale()
6953
6901
  */
6954
6902
  getScale(): Common.Vector3;
6955
6903
  /**
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
6904
+ @copydoc IScaleComponent::SetScale()
6963
6905
  */
6964
6906
  setScale(value: Common.Vector3): void;
6965
6907
  /**
6908
+ @copydoc ITransformComponent::GetTransform()
6909
+ */
6910
+ getTransform(): Multiplayer.SpaceTransform;
6911
+ /**
6912
+ @copydoc ITransformComonent::SetTransform()
6913
+ */
6914
+ setTransform(value: Multiplayer.SpaceTransform): void;
6915
+ /**
6916
+ @}
6966
6917
  * \addtogroup IVisibleComponent
6967
6918
  @{
6968
6919
  @copydoc IVisibleComponent::GetIsVisible()
@@ -6988,7 +6939,7 @@ export declare namespace Multiplayer {
6988
6939
  @ingroup FogSpaceComponent
6989
6940
  * @description Data representation of an FogSpaceComponent.
6990
6941
  */
6991
- class FogSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IVisibleComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
6942
+ class FogSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
6992
6943
  /** @internal */
6993
6944
  constructor(pointer: NativePointer);
6994
6945
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.FogSpaceComponent;
@@ -7008,70 +6959,41 @@ export declare namespace Multiplayer {
7008
6959
  */
7009
6960
  setFogMode(value: Multiplayer.FogMode): void;
7010
6961
  /**
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.
6962
+ * \addtogroup ITransformComponent
6963
+ @{
6964
+ @copydoc IPositionComponent::GetPosition()
7018
6965
  */
7019
6966
  getPosition(): Common.Vector3;
7020
6967
  /**
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
6968
+ @copydoc IPositionComponent::SetPosition()
7027
6969
  */
7028
6970
  setPosition(value: Common.Vector3): void;
7029
6971
  /**
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
6972
+ @copydoc IRotationComponent::GetRotation()
7039
6973
  */
7040
6974
  getRotation(): Common.Vector4;
7041
6975
  /**
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.
6976
+ @copydoc IRotationComponent::SetRotation()
7052
6977
  */
7053
6978
  setRotation(value: Common.Vector4): void;
7054
6979
  /**
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).
6980
+ @copydoc IScaleComponent::GetScale()
7062
6981
  */
7063
6982
  getScale(): Common.Vector3;
7064
6983
  /**
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
6984
+ @copydoc IScaleComponent::SetScale()
7072
6985
  */
7073
6986
  setScale(value: Common.Vector3): void;
7074
6987
  /**
6988
+ @copydoc ITransformComponent::GetTransform()
6989
+ */
6990
+ getTransform(): Multiplayer.SpaceTransform;
6991
+ /**
6992
+ @copydoc ITransformComonent::SetTransform()
6993
+ */
6994
+ setTransform(value: Multiplayer.SpaceTransform): void;
6995
+ /**
6996
+ @}
7075
6997
  * @description Get start sistance
7076
6998
  * Note: Distance from camera that the fog will start.
7077
6999
  * Note: 0 = this property has no effect.
@@ -7193,7 +7115,7 @@ export declare namespace Multiplayer {
7193
7115
  @ingroup ImageSpaceComponent
7194
7116
  * @description Data representation of an ImageSpaceComponent.
7195
7117
  */
7196
- class ImageSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IVisibleComponent, INativeResource {
7118
+ class ImageSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
7197
7119
  /** @internal */
7198
7120
  constructor(pointer: NativePointer);
7199
7121
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.ImageSpaceComponent;
@@ -7235,70 +7157,41 @@ export declare namespace Multiplayer {
7235
7157
  */
7236
7158
  setAssetCollectionId(value: string): void;
7237
7159
  /**
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.
7160
+ * \addtogroup ITransformComponent
7161
+ @{
7162
+ @copydoc IPositionComponent::GetPosition()
7245
7163
  */
7246
7164
  getPosition(): Common.Vector3;
7247
7165
  /**
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
7166
+ @copydoc IPositionComponent::SetPosition()
7254
7167
  */
7255
7168
  setPosition(value: Common.Vector3): void;
7256
7169
  /**
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
7170
+ @copydoc IRotationComponent::GetRotation()
7266
7171
  */
7267
7172
  getRotation(): Common.Vector4;
7268
7173
  /**
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.
7174
+ @copydoc IRotationComponent::SetRotation()
7279
7175
  */
7280
7176
  setRotation(value: Common.Vector4): void;
7281
7177
  /**
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).
7178
+ @copydoc IScaleComponent::GetScale()
7289
7179
  */
7290
7180
  getScale(): Common.Vector3;
7291
7181
  /**
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
7182
+ @copydoc IScaleComponent::SetScale()
7299
7183
  */
7300
7184
  setScale(value: Common.Vector3): void;
7301
7185
  /**
7186
+ @copydoc ITransformComponent::GetTransform()
7187
+ */
7188
+ getTransform(): Multiplayer.SpaceTransform;
7189
+ /**
7190
+ @copydoc ITransformComonent::SetTransform()
7191
+ */
7192
+ setTransform(value: Multiplayer.SpaceTransform): void;
7193
+ /**
7194
+ @}
7302
7195
  * @description Gets the billboard mode used by this image component.
7303
7196
  * @return The billboard mode used by this image component.
7304
7197
  */
@@ -7354,7 +7247,7 @@ export declare namespace Multiplayer {
7354
7247
  @ingroup LightSpaceComponent
7355
7248
  * @description Data representation of an LightSpaceComponent.
7356
7249
  */
7357
- class LightSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IVisibleComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
7250
+ class LightSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, Multiplayer.IRotationComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.IVisibleComponent, INativeResource {
7358
7251
  /** @internal */
7359
7252
  constructor(pointer: NativePointer);
7360
7253
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.LightSpaceComponent;
@@ -7434,50 +7327,28 @@ export declare namespace Multiplayer {
7434
7327
  */
7435
7328
  setOuterConeAngle(value: number): void;
7436
7329
  /**
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.
7330
+ * \addtogroup IPositionComponent
7331
+ @{
7332
+ @copydoc IPositionComponent::GetPosition()
7444
7333
  */
7445
7334
  getPosition(): Common.Vector3;
7446
7335
  /**
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
7336
+ @copydoc IPositionComponent::SetPosition()
7453
7337
  */
7454
7338
  setPosition(value: Common.Vector3): void;
7455
7339
  /**
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
7340
+ @}
7341
+ * \addtogroup IRotationComponent
7342
+ @{
7343
+ @copydoc IRotationComponent::GetRotation()
7465
7344
  */
7466
7345
  getRotation(): Common.Vector4;
7467
7346
  /**
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.
7347
+ @copydoc IRotationComponent::SetRotation()
7478
7348
  */
7479
7349
  setRotation(value: Common.Vector4): void;
7480
7350
  /**
7351
+ @}
7481
7352
  * @description Gets the ID of the asset used for the light cookie of this light component.
7482
7353
  * @return The ID of the asset used for the light cookie of this light component.
7483
7354
  */
@@ -7540,7 +7411,7 @@ export declare namespace Multiplayer {
7540
7411
  }
7541
7412
  }
7542
7413
  export declare namespace Multiplayer {
7543
- class PortalSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, INativeResource {
7414
+ class PortalSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.IPositionComponent, INativeResource {
7544
7415
  /** @internal */
7545
7416
  constructor(pointer: NativePointer);
7546
7417
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.PortalSpaceComponent;
@@ -7564,25 +7435,17 @@ export declare namespace Multiplayer {
7564
7435
  */
7565
7436
  setSpaceId(value: string): void;
7566
7437
  /**
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.
7438
+ * \addtogroup IPositionComponent
7439
+ @{
7440
+ @copydoc IPositionComponent::GetPosition()
7574
7441
  */
7575
7442
  getPosition(): Common.Vector3;
7576
7443
  /**
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
7444
+ @copydoc IPositionComponent::SetPosition()
7583
7445
  */
7584
7446
  setPosition(value: Common.Vector3): void;
7585
7447
  /**
7448
+ @}
7586
7449
  * @description Gets the radius of this portal.
7587
7450
  * @return The radius of this portal.
7588
7451
  */
@@ -7618,7 +7481,7 @@ export declare namespace Multiplayer {
7618
7481
  @ingroup ReflectionSpaceComponent
7619
7482
  * @description Data representation of an ReflectionSpaceComponent.
7620
7483
  */
7621
- class ReflectionSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IThirdPartyComponentRef, INativeResource {
7484
+ class ReflectionSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, Multiplayer.IScaleComponent, Multiplayer.IThirdPartyComponentRef, INativeResource {
7622
7485
  /** @internal */
7623
7486
  constructor(pointer: NativePointer);
7624
7487
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.ReflectionSpaceComponent;
@@ -7659,31 +7522,28 @@ export declare namespace Multiplayer {
7659
7522
  */
7660
7523
  setAssetCollectionId(value: string): void;
7661
7524
  /**
7662
- * @description Position of the Reflection component.
7525
+ * \addtogroup IPositionComponent
7526
+ @{
7527
+ @copydoc IPositionComponent::GetPosition()
7663
7528
  */
7664
7529
  getPosition(): Common.Vector3;
7665
7530
  /**
7666
- * @description Set the position of the Reflection component.
7667
- * @param value - Position of the Reflection Component.
7531
+ @copydoc IPositionComponent::SetPosition()
7668
7532
  */
7669
7533
  setPosition(value: Common.Vector3): void;
7670
7534
  /**
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.
7535
+ @}
7536
+ * \addtogroup IScaleComponent
7537
+ @{
7538
+ @copydoc IScaleComponent::GetScale()
7678
7539
  */
7679
7540
  getScale(): Common.Vector3;
7680
7541
  /**
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.
7542
+ @copydoc IScaleComponent::SetScale()
7684
7543
  */
7685
7544
  setScale(value: Common.Vector3): void;
7686
7545
  /**
7546
+ @}
7687
7547
  * @description Get the reflection shape enum value.
7688
7548
  * ReflectionShape.UnitBox: Projects a texture in a planar fashion from all six directions (like an inward facing cube).
7689
7549
  * ReflectionShape.UnitSphere: Warps the texture into a spherical shape and projects it onto a surface.
@@ -7794,7 +7654,7 @@ export declare namespace Multiplayer {
7794
7654
  @ingroup StaticModelSpaceComponent
7795
7655
  * @description Data representation of an StaticModelSpaceComponent.
7796
7656
  */
7797
- class StaticModelSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, Multiplayer.IExternalResourceComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.IShadowCasterComponent, INativeResource {
7657
+ class StaticModelSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IExternalResourceComponent, Multiplayer.IShadowCasterComponent, Multiplayer.IThirdPartyComponentRef, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
7798
7658
  /** @internal */
7799
7659
  constructor(pointer: NativePointer);
7800
7660
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.StaticModelSpaceComponent;
@@ -7803,7 +7663,13 @@ export declare namespace Multiplayer {
7803
7663
  * @param parent - The Space entity that owns this component.
7804
7664
  */
7805
7665
  static create_parent(parent: Multiplayer.SpaceEntity): StaticModelSpaceComponent;
7666
+ /** @deprecated
7667
+ Due to the introduction of LODs it doesn't make sense to set a specific asset anymore
7668
+ */
7806
7669
  getExternalResourceAssetId(): string;
7670
+ /** @deprecated
7671
+ Due to the introduction of LODs it doesn't make sense to set a specific asset anymore
7672
+ */
7807
7673
  setExternalResourceAssetId(value: string): void;
7808
7674
  /**
7809
7675
  * @description Gets the ID of the asset collection associated with this component.
@@ -7900,7 +7766,7 @@ export declare namespace Multiplayer {
7900
7766
  @ingroup VideoPlayerSpaceComponent
7901
7767
  * @description Data representation of an VideoPlayerSpaceComponent.
7902
7768
  */
7903
- class VideoPlayerSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IVisibleComponent, Multiplayer.IEnableableComponent, INativeResource {
7769
+ class VideoPlayerSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IEnableableComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
7904
7770
  /** @internal */
7905
7771
  constructor(pointer: NativePointer);
7906
7772
  static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.VideoPlayerSpaceComponent;
@@ -7952,70 +7818,41 @@ export declare namespace Multiplayer {
7952
7818
  */
7953
7819
  setAssetCollectionId(value: string): void;
7954
7820
  /**
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.
7821
+ * \addtogroup ITransformComponent
7822
+ @{
7823
+ @copydoc IPositionComponent::GetPosition()
7962
7824
  */
7963
7825
  getPosition(): Common.Vector3;
7964
7826
  /**
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
7827
+ @copydoc IPositionComponent::SetPosition()
7971
7828
  */
7972
7829
  setPosition(value: Common.Vector3): void;
7973
7830
  /**
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
7831
+ @copydoc IRotationComponent::GetRotation()
7983
7832
  */
7984
7833
  getRotation(): Common.Vector4;
7985
7834
  /**
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.
7835
+ @copydoc IRotationComponent::SetRotation()
7996
7836
  */
7997
7837
  setRotation(value: Common.Vector4): void;
7998
7838
  /**
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).
7839
+ @copydoc IScaleComponent::GetScale()
8006
7840
  */
8007
7841
  getScale(): Common.Vector3;
8008
7842
  /**
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
7843
+ @copydoc IScaleComponent::SetScale()
8016
7844
  */
8017
7845
  setScale(value: Common.Vector3): void;
8018
7846
  /**
7847
+ @copydoc ITransformComponent::GetTransform()
7848
+ */
7849
+ getTransform(): Multiplayer.SpaceTransform;
7850
+ /**
7851
+ @copydoc ITransformComonent::SetTransform()
7852
+ */
7853
+ setTransform(value: Multiplayer.SpaceTransform): void;
7854
+ /**
7855
+ @}
8019
7856
  * @description Checks if the playback state of this video player needs to be shared with other users through replication.
8020
7857
  * @return True if the playback state of the video needs to be shared among all users, false otherwise.
8021
7858
  */
@@ -8375,6 +8212,7 @@ export declare namespace Systems {
8375
8212
  * @return Uri of the uploaded asset.
8376
8213
  */
8377
8214
  getUri(): string;
8215
+ setUri(value: string): void;
8378
8216
  delete(): void;
8379
8217
  }
8380
8218
  }
@@ -8963,9 +8801,6 @@ export declare namespace Systems {
8963
8801
  /** @internal */
8964
8802
  constructor(pointer: NativePointer);
8965
8803
  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
8804
  /**
8970
8805
  * @description Retrieves response data from the Maintenance Window Server
8971
8806
  * @return Return all maintenance information available in date order
@@ -9169,6 +9004,22 @@ export declare namespace Systems {
9169
9004
  delete(): void;
9170
9005
  }
9171
9006
  }
9007
+ export declare namespace Systems {
9008
+ /**
9009
+ * @description A result handler that is used to notify a user of an error while passing a String value.
9010
+ */
9011
+ class AvatarInfoResult extends Systems.ResultBase implements INativeResource {
9012
+ /** @internal */
9013
+ constructor(pointer: NativePointer);
9014
+ static fromResultBase(baseInstance: Systems.ResultBase): Systems.AvatarInfoResult;
9015
+ /**
9016
+ * @description A getter which returns the String passed via the result.
9017
+ */
9018
+ getAvatarType(): Systems.AvatarType;
9019
+ getAvatarIdentifier(): Common.Variant;
9020
+ delete(): void;
9021
+ }
9022
+ }
9172
9023
  export declare namespace Systems {
9173
9024
  /**
9174
9025
  @ingroup Settings System
@@ -9269,6 +9120,20 @@ export declare namespace Systems {
9269
9120
  * @param callback - Callback when asynchronous task finishes
9270
9121
  */
9271
9122
  updateAvatarPortraitWithBuffer(userId: string, newAvatarPortrait: Systems.BufferAssetDataSource): Promise<Systems.NullResult>;
9123
+ /**
9124
+ * @description Sets the avatar type and identifier for a user.
9125
+ * @param inUserId - The ID of the user to set avatar info for.
9126
+ * @param inType - The type of avatar (predefined, Ready Player Me, or custom).
9127
+ * @param inIdentifier - A value used to identify or locate the avatar. Differs depending on the value of InType.
9128
+ * @param callback - Callback to call when task finishes.
9129
+ */
9130
+ setAvatarInfo(userId: string, type: Systems.AvatarType, identifier: Common.Variant): Promise<Systems.NullResult>;
9131
+ /**
9132
+ * @description Retrieves the avatar type and identifier for a user.
9133
+ * @param inUserId - The ID of the user to get avatar info for.
9134
+ * @param callback - Callback to call when task finishes.
9135
+ */
9136
+ getAvatarInfo(userId: string): Promise<Systems.AvatarInfoResult>;
9272
9137
  }
9273
9138
  }
9274
9139
  export declare namespace Systems {
@@ -10147,14 +10012,13 @@ export declare namespace Systems {
10147
10012
  */
10148
10013
  login(userName: string, email: string, password: string, userHasVerifiedAge: boolean | null): Promise<Systems.LoginStateResult>;
10149
10014
  /**
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
10015
+ * @description Resume a previous session for the associated user ID using a refresh token
10016
+ * The refresh token can be obtained after registering a callback with `SetNewLoginTokenReceivedCallback` and logging in regularly.
10017
+ * @param userId - User ID for the previous session
10018
+ * @param refreshToken - Refresh token to be used for refreshing the authentication token
10155
10019
  * @param callback - Callback when asynchronous task finishes
10156
10020
  */
10157
- loginWithToken(userId: string, loginToken: string): Promise<Systems.LoginStateResult>;
10021
+ refreshSession(userId: string, refreshToken: string): Promise<Systems.LoginStateResult>;
10158
10022
  /**
10159
10023
  * @description Log in to Magnopus Connected Services as a guest.
10160
10024
  * @param userHasVerifiedAge - An optional bool to specify whether or not the user has verified that they are over 18
@@ -10244,7 +10108,7 @@ export declare namespace Systems {
10244
10108
  */
10245
10109
  updateUserDisplayName(userId: string, newUserDisplayName: string): Promise<Systems.NullResult>;
10246
10110
  /**
10247
- * @description Delete the user.
10111
+ * @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
10112
  * @param userId - Id of the user that will be deleted
10249
10113
  * @param callback - Callback when asynchronous task finishes
10250
10114
  */