connected-spaces-platform.web 5.18.0 → 5.20.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.
@@ -72,16 +72,17 @@ export declare class NativeRef {
72
72
  set value(value: number | bigint);
73
73
  }
74
74
  declare type ProxyClassFactory = (nativePointer: NativePointer) => NativeClassWrapper | number | string;
75
- export declare namespace Systems {
75
+ export declare namespace Common {
76
76
  /**
77
- * @description Enum for setting csp::systems::Asset third party platform type.
78
- * NONE indicates that the asset will work on any platform.
79
- * Any other value indicates it will only work with this platform.
77
+ * @description Enum which represents possible login states of a CSP client.
80
78
  */
81
- enum EThirdPartyPlatform {
82
- NONE = 0,
83
- UNREAL = 1,
84
- UNITY = 2
79
+ enum ELoginState {
80
+ LoginThirdPartyProviderDetailsRequested = 0,
81
+ LoginRequested = 1,
82
+ LoggedIn = 2,
83
+ LogoutRequested = 3,
84
+ LoggedOut = 4,
85
+ Error = 5
85
86
  }
86
87
  }
87
88
  export declare namespace Web {
@@ -165,6 +166,17 @@ export declare namespace Multiplayer {
165
166
  SpaceUserLimitExceeded = 4
166
167
  }
167
168
  }
169
+ export declare namespace Systems {
170
+ /**
171
+ * @description Indicates special handling for any thirdparty platform
172
+ * NOTE: We may remove this soon, as it's deceptive implying these are the only platforms we support.
173
+ */
174
+ enum EThirdPartyPlatform {
175
+ NONE = 0,
176
+ UNREAL = 1,
177
+ UNITY = 2
178
+ }
179
+ }
168
180
  export declare namespace Systems {
169
181
  /**
170
182
  * @description Code to indicate the result of a request.
@@ -337,6 +349,27 @@ export declare namespace Multiplayer {
337
349
  Disconnected = 3
338
350
  }
339
351
  }
352
+ export declare namespace Multiplayer {
353
+ /**
354
+ * @description Enum used to specify the SignalR method to invoke in the multiplayer connection.
355
+ */
356
+ enum MultiplayerHubMethod {
357
+ DELETE_OBJECTS = 0,
358
+ GENERATE_OBJECT_IDS = 1,
359
+ GET_CLIENT_ID = 2,
360
+ PAGE_SCOPED_OBJECTS = 3,
361
+ RESET_SCOPES = 4,
362
+ SEND_EVENT_MESSAGE = 5,
363
+ SEND_OBJECT_MESSAGE = 6,
364
+ SEND_OBJECT_NOT_FOUND = 7,
365
+ SEND_OBJECT_PATCH = 8,
366
+ SEND_OBJECT_PATCHES = 9,
367
+ SET_ALLOW_SELF_MESSAGING = 10,
368
+ SET_SCOPES = 11,
369
+ START_LISTENING = 12,
370
+ STOP_LISTENING = 13
371
+ }
372
+ }
340
373
  export declare namespace Multiplayer {
341
374
  /**
342
375
  * @description Enum representing the type of a replicated value.
@@ -1237,16 +1270,6 @@ export declare namespace Systems {
1237
1270
  SPACE = 1
1238
1271
  }
1239
1272
  }
1240
- export declare namespace Systems {
1241
- enum ELoginState {
1242
- LoginThirdPartyProviderDetailsRequested = 0,
1243
- LoginRequested = 1,
1244
- LoggedIn = 2,
1245
- LogoutRequested = 3,
1246
- LoggedOut = 4,
1247
- Error = 5
1248
- }
1249
- }
1250
1273
  export declare namespace Systems {
1251
1274
  /**
1252
1275
  * @description FDN supported Authentication Providers, the ones that can be used are the ones above Num
@@ -1490,6 +1513,31 @@ export declare namespace Systems {
1490
1513
  setMimeType: (mimeType: string) => void;
1491
1514
  }
1492
1515
  }
1516
+ /**
1517
+ * @description Represents definition for identifying and versioning an external service endpoint..
1518
+ */
1519
+ export declare class ServiceDefinition extends NativeClassWrapper implements INativeResource {
1520
+ /** @internal */
1521
+ constructor(pointer: NativePointer);
1522
+ static create(): ServiceDefinition;
1523
+ static create_uRI_version(uRI: string, version: number): ServiceDefinition;
1524
+ /**
1525
+ * @description Gets the URI for the service endpoint.
1526
+ * @return URI of the service endpoint.
1527
+ */
1528
+ getURI(): string;
1529
+ /**
1530
+ * @description Sets the URI for the service endpoint.
1531
+ * @param inURI - URI for service endpoint.
1532
+ */
1533
+ setURI(uRI: string): void;
1534
+ /**
1535
+ * @description Gets the current version of the service endpoint.
1536
+ * @return Representing the current version of the service endpoint.
1537
+ */
1538
+ getVersion(): number;
1539
+ delete(): void;
1540
+ }
1493
1541
  /**
1494
1542
  * @description Holds supported endpoint uris used by Foundation.
1495
1543
  */
@@ -1498,20 +1546,20 @@ export declare class EndpointURIs extends NativeClassWrapper implements INativeR
1498
1546
  constructor(pointer: NativePointer);
1499
1547
  static create(): EndpointURIs;
1500
1548
  delete(): void;
1501
- get userServiceURI(): string;
1502
- set userServiceURI(value: string);
1503
- get prototypeServiceURI(): string;
1504
- set prototypeServiceURI(value: string);
1505
- get spatialDataServiceURI(): string;
1506
- set spatialDataServiceURI(value: string);
1507
- get multiplayerServiceURI(): string;
1508
- set multiplayerServiceURI(value: string);
1509
- get aggregationServiceURI(): string;
1510
- set aggregationServiceURI(value: string);
1511
- get trackingServiceURI(): string;
1512
- set trackingServiceURI(value: string);
1513
- get maintenanceWindowURI(): string;
1514
- set maintenanceWindowURI(value: string);
1549
+ get userService(): ServiceDefinition;
1550
+ set userService(value: ServiceDefinition);
1551
+ get prototypeService(): ServiceDefinition;
1552
+ set prototypeService(value: ServiceDefinition);
1553
+ get spatialDataService(): ServiceDefinition;
1554
+ set spatialDataService(value: ServiceDefinition);
1555
+ get multiplayerService(): ServiceDefinition;
1556
+ set multiplayerService(value: ServiceDefinition);
1557
+ get aggregationService(): ServiceDefinition;
1558
+ set aggregationService(value: ServiceDefinition);
1559
+ get trackingService(): ServiceDefinition;
1560
+ set trackingService(value: ServiceDefinition);
1561
+ get maintenanceWindow(): ServiceDefinition;
1562
+ set maintenanceWindow(value: ServiceDefinition);
1515
1563
  }
1516
1564
  /**
1517
1565
  * @description Holds client data used in requests for all Magnopus Serives.
@@ -1651,6 +1699,33 @@ export declare namespace Common {
1651
1699
  static dummy(): Common.CancellationToken;
1652
1700
  }
1653
1701
  }
1702
+ export declare namespace Common {
1703
+ /**
1704
+ * @description Data structure representing the user login state, including detection of access token expiry
1705
+ */
1706
+ class LoginState extends NativeClassWrapper implements INativeResource {
1707
+ /** @internal */
1708
+ constructor(pointer: NativePointer);
1709
+ static create(): LoginState;
1710
+ delete(): void;
1711
+ static create_otherState(otherState: Common.LoginState): LoginState;
1712
+ /**
1713
+ * @description Check if the access token for the login is expired.
1714
+ * @return Is the token expired.
1715
+ */
1716
+ refreshNeeded(): boolean;
1717
+ get state(): Common.ELoginState;
1718
+ set state(value: Common.ELoginState);
1719
+ get accessToken(): string;
1720
+ set accessToken(value: string);
1721
+ get refreshToken(): string;
1722
+ set refreshToken(value: string);
1723
+ get userId(): string;
1724
+ set userId(value: string);
1725
+ get deviceId(): string;
1726
+ set deviceId(value: string);
1727
+ }
1728
+ }
1654
1729
  export declare namespace Common {
1655
1730
  /**
1656
1731
  * @description Holds all valid mime types.
@@ -3493,6 +3568,27 @@ export declare namespace Common {
3493
3568
  set w(value: number);
3494
3569
  }
3495
3570
  }
3571
+ export declare namespace Common {
3572
+ class InvalidInterfaceUseError extends NativeClassWrapper implements INativeResource {
3573
+ /** @internal */
3574
+ constructor(pointer: NativePointer);
3575
+ static create_msg(msg: string): InvalidInterfaceUseError;
3576
+ delete(): void;
3577
+ get msg(): string;
3578
+ set msg(value: string);
3579
+ }
3580
+ }
3581
+ export declare namespace Common {
3582
+ class IJSScriptRunner extends NativeClassWrapper implements INativeResource {
3583
+ /** @internal */
3584
+ constructor(pointer: NativePointer);
3585
+ /**
3586
+ * @description Virtual destructor.
3587
+ */
3588
+ delete(): void;
3589
+ runScript(contextId: bigint, scriptText: string): boolean;
3590
+ }
3591
+ }
3496
3592
  export declare namespace Common {
3497
3593
  class IRealtimeEngine extends NativeClassWrapper implements INativeResource {
3498
3594
  /** @internal */
@@ -4138,7 +4234,7 @@ export declare namespace Multiplayer {
4138
4234
  /**
4139
4235
  * @description Creates a SpaceEntity instance using the space entity system provided.
4140
4236
  */
4141
- static create_entitySystem(entitySystem: Multiplayer.SpaceEntitySystem): SpaceEntity;
4237
+ static create_entitySystem_scriptRunner_logSystem(entitySystem: Multiplayer.SpaceEntitySystem, scriptRunner: Common.IJSScriptRunner, logSystem: Common.LogSystem): SpaceEntity;
4142
4238
  /**
4143
4239
  * @description Destroys the SpaceEntity instance.
4144
4240
  */
@@ -4417,7 +4513,7 @@ export declare namespace Multiplayer {
4417
4513
  * @param callback - EntityCreatedCallback A callback that executes when the creation is complete,
4418
4514
  * which contains a pointer to the new SpaceEntity so that it can be used on the local client.
4419
4515
  */
4420
- createAvatar(name: string, spaceTransform: Multiplayer.SpaceTransform, isVisible: boolean, state: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode): Promise<Multiplayer.SpaceEntity>;
4516
+ createAvatar(name: string, loginState: Common.LoginState, spaceTransform: Multiplayer.SpaceTransform, isVisible: boolean, state: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode): Promise<Multiplayer.SpaceEntity>;
4421
4517
  /**
4422
4518
  * @description Creates a SpaceEntity of type Object, and relevant default values.
4423
4519
  * @param inName - The name to give the new SpaceEntity.
@@ -5756,37 +5852,6 @@ export declare namespace Systems {
5756
5852
  set period(value: Systems.PeriodEnum);
5757
5853
  }
5758
5854
  }
5759
- export declare namespace Systems {
5760
- /**
5761
- * @description A JavaScript based scripting system that can be used to create advanced behaviours and interactions between entities in spaces.
5762
- */
5763
- class ScriptSystem extends NativeClassWrapper {
5764
- /** @internal */
5765
- constructor(pointer: NativePointer);
5766
- /**
5767
- * @description Starts up the JavaScript runtime context.
5768
- */
5769
- initialise(): void;
5770
- /**
5771
- * @description Shuts down and deletes the JavaScript runtime context.
5772
- */
5773
- shutdown(): void;
5774
- /**
5775
- * @description Attempts to execute a script in a given context.
5776
- * @param contextId - The context in which to run the script. If the provided context does not exist, the script run will fail.
5777
- * @param scriptText - The script to execute.
5778
- * @return A boolean representing success running the script.
5779
- */
5780
- runScript(contextId: bigint, scriptText: string): boolean;
5781
- /**
5782
- * @description Attempts to execute a script from a given file path in the given context.
5783
- * @param contextId - The context in which to run the script. If the provided context does not exist, the script run will fail.
5784
- * @param scriptFilePath - The file path of the script to execute.
5785
- * @return A boolean representing success running the script.
5786
- */
5787
- runScriptFile(contextId: bigint, scriptFilePath: string): boolean;
5788
- }
5789
- }
5790
5855
  export declare namespace Systems {
5791
5856
  /**
5792
5857
  @ingroup Sequence System
@@ -6102,33 +6167,6 @@ export declare namespace Systems {
6102
6167
  set w(value: number);
6103
6168
  }
6104
6169
  }
6105
- export declare namespace Systems {
6106
- /**
6107
- * @description Data structure representing the user login state, including detection of access token expiry
6108
- */
6109
- class LoginState extends NativeClassWrapper implements INativeResource {
6110
- /** @internal */
6111
- constructor(pointer: NativePointer);
6112
- static create(): LoginState;
6113
- delete(): void;
6114
- static create_otherState(otherState: Systems.LoginState): LoginState;
6115
- /**
6116
- * @description Check if the access token for the login is expired.
6117
- * @return Is the token expired.
6118
- */
6119
- refreshNeeded(): boolean;
6120
- get state(): Systems.ELoginState;
6121
- set state(value: Systems.ELoginState);
6122
- get accessToken(): string;
6123
- set accessToken(value: string);
6124
- get refreshToken(): string;
6125
- set refreshToken(value: string);
6126
- get userId(): string;
6127
- set userId(value: string);
6128
- get deviceId(): string;
6129
- set deviceId(value: string);
6130
- }
6131
- }
6132
6170
  export declare namespace Systems {
6133
6171
  /**
6134
6172
  * @description Data for access and refresh tokens, and their expiry times.
@@ -6268,7 +6306,7 @@ export declare namespace Multiplayer {
6268
6306
  * @description Constructs the animated model space component, and associates it with the specified Parent space entity.
6269
6307
  * @param parent - The Space entity that owns this component.
6270
6308
  */
6271
- static create_parent(parent: Multiplayer.SpaceEntity): AnimatedModelSpaceComponent;
6309
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): AnimatedModelSpaceComponent;
6272
6310
  /** @deprecated
6273
6311
  Due to the introduction of LODs it doesn't make sense to set a specific asset anymore
6274
6312
  */
@@ -6430,7 +6468,7 @@ export declare namespace Multiplayer {
6430
6468
  * @description Constructs the audio space component, and associates it with the specified Parent space entity.
6431
6469
  * @param parent - The Space entity that owns this component.
6432
6470
  */
6433
- static create_parent(parent: Multiplayer.SpaceEntity): AudioSpaceComponent;
6471
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): AudioSpaceComponent;
6434
6472
  /**
6435
6473
  * \addtogroup IPositionComponent
6436
6474
  @{
@@ -6570,7 +6608,7 @@ export declare namespace Multiplayer {
6570
6608
  * @description Constructs the avatar space component, and associates it with the specified Parent space entity.
6571
6609
  * @param parent - The Space entity that owns this component.
6572
6610
  */
6573
- static create_parent(parent: Multiplayer.SpaceEntity): AvatarSpaceComponent;
6611
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): AvatarSpaceComponent;
6574
6612
  /**
6575
6613
  * @description Gets the ID for the avatar of this avatar component.
6576
6614
  * NOTE: Used for selecting a specific avatar depending on the user's preferences.
@@ -6813,7 +6851,7 @@ export declare namespace Multiplayer {
6813
6851
  * @description Constructs the button space component, and associates it with the specified Parent space entity.
6814
6852
  * @param parent - The Space entity that owns this component.
6815
6853
  */
6816
- static create_parent(parent: Multiplayer.SpaceEntity): ButtonSpaceComponent;
6854
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): ButtonSpaceComponent;
6817
6855
  /**
6818
6856
  * @description Gets the text of the label of this button.
6819
6857
  * @return The text on the label of this button.
@@ -6928,7 +6966,7 @@ export declare namespace Multiplayer {
6928
6966
  * @description Constructs the CinematicCamera space component, and associates it with the specified Parent space entity.
6929
6967
  * @param parent - The Space entity that owns this component.
6930
6968
  */
6931
- static create_parent(parent: Multiplayer.SpaceEntity): CinematicCameraSpaceComponent;
6969
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): CinematicCameraSpaceComponent;
6932
6970
  /**
6933
6971
  * @description Gived the sensor size and focal length, return the horizonal fov
6934
6972
  * @return FOV in radians
@@ -7096,7 +7134,7 @@ export declare namespace Multiplayer {
7096
7134
  * @description Constructs the collision space component, and associates it with the specified Parent space entity.
7097
7135
  * @param parent - The Space entity that owns this component.
7098
7136
  */
7099
- static create_parent(parent: Multiplayer.SpaceEntity): CollisionSpaceComponent;
7137
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): CollisionSpaceComponent;
7100
7138
  /**
7101
7139
  * \addtogroup ITransformComponent
7102
7140
  @{
@@ -7237,7 +7275,7 @@ export declare namespace Multiplayer {
7237
7275
  * @param parent - The Space entity that owns this component. This will also register the component to the entity.
7238
7276
  @pre Parent must not be null.
7239
7277
  */
7240
- static create_parent(parent: Multiplayer.SpaceEntity): ConversationSpaceComponent;
7278
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): ConversationSpaceComponent;
7241
7279
  /**
7242
7280
  * @description Creates a conversation represented by this component.
7243
7281
  * @param message - The message to be stored.
@@ -7488,7 +7526,7 @@ export declare namespace Multiplayer {
7488
7526
  * @description Constructs the custom space component, and associates it with the specified Parent space entity.
7489
7527
  * @param parent - The Space entity that owns this component.
7490
7528
  */
7491
- static create_parent(parent: Multiplayer.SpaceEntity): CustomSpaceComponent;
7529
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): CustomSpaceComponent;
7492
7530
  /**
7493
7531
  * @description Gets a string that identifies the application origin.
7494
7532
  * @return The application origin for which this component has been generated.
@@ -7554,7 +7592,7 @@ export declare namespace Multiplayer {
7554
7592
  * @description Constructs the ECommerce space component, and associates it with the specified Parent space entity.
7555
7593
  * @param parent - The Space entity that owns this component.
7556
7594
  */
7557
- static create_parent(parent: Multiplayer.SpaceEntity): ECommerceSpaceComponent;
7595
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): ECommerceSpaceComponent;
7558
7596
  /**
7559
7597
  * \addtogroup ITransformComponent
7560
7598
  @{
@@ -7592,7 +7630,7 @@ export declare namespace Multiplayer {
7592
7630
  * @description Creates an external link component that can be added to an existing space entity.
7593
7631
  * @param parent - - The space entity to which this new component will belong to.
7594
7632
  */
7595
- static create_parent(parent: Multiplayer.SpaceEntity): ExternalLinkSpaceComponent;
7633
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): ExternalLinkSpaceComponent;
7596
7634
  /**
7597
7635
  * @description Gets the name of this external link component.
7598
7636
  */
@@ -7706,7 +7744,7 @@ export declare namespace Multiplayer {
7706
7744
  * @description Constructs the fiducial marker space component, and associates it with the specified Parent space entity.
7707
7745
  * @param parent - The Space entity that owns this component.
7708
7746
  */
7709
- static create_parent(parent: Multiplayer.SpaceEntity): FiducialMarkerSpaceComponent;
7747
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): FiducialMarkerSpaceComponent;
7710
7748
  /**
7711
7749
  * @description Gets the name of this fiducial marker space component.
7712
7750
  * @return The name of this fiducial marker space component.
@@ -7814,7 +7852,7 @@ export declare namespace Multiplayer {
7814
7852
  * @description Constructs the fog space component, and associates it with the specified Parent space entity.
7815
7853
  * @param parent - The Space entity that owns this component.
7816
7854
  */
7817
- static create_parent(parent: Multiplayer.SpaceEntity): FogSpaceComponent;
7855
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): FogSpaceComponent;
7818
7856
  /**
7819
7857
  * @description Retrieves the type of fog currently used by this fog component.
7820
7858
  * @return The modality of fog currently used by this component.
@@ -7994,7 +8032,7 @@ export declare namespace Multiplayer {
7994
8032
  * @description Constructs the Gaussian Splat component, and associates it with the specified Parent space entity.
7995
8033
  * @param parent - The Space entity that owns this component.
7996
8034
  */
7997
- static create_parent(parent: Multiplayer.SpaceEntity): GaussianSplatSpaceComponent;
8035
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): GaussianSplatSpaceComponent;
7998
8036
  /**
7999
8037
  * @description Gets the ID of the asset associated with this component.
8000
8038
  * NOTE: To retrieve this component's gaussian splat asset, both the Asset ID and the Asset Collection ID are required.
@@ -8115,7 +8153,7 @@ export declare namespace Multiplayer {
8115
8153
  * @description Constructs the Hotspot space component, and associates it with the specified Parent space entity.
8116
8154
  * @param parent - The Space entity that owns this component.
8117
8155
  */
8118
- static create_parent(parent: Multiplayer.SpaceEntity): HotspotSpaceComponent;
8156
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): HotspotSpaceComponent;
8119
8157
  /**
8120
8158
  * @description Gets the Name of the Hotspot.
8121
8159
  * @return The Name of the Hotspot.
@@ -8212,7 +8250,7 @@ export declare namespace Multiplayer {
8212
8250
  * @description Constructs the image space component, and associates it with the specified Parent space entity.
8213
8251
  * @param parent - The Space entity that owns this component.
8214
8252
  */
8215
- static create_parent(parent: Multiplayer.SpaceEntity): ImageSpaceComponent;
8253
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): ImageSpaceComponent;
8216
8254
  /**
8217
8255
  * @description Gets the name of this image space component.
8218
8256
  * @return The name of this image space component.
@@ -8351,7 +8389,7 @@ export declare namespace Multiplayer {
8351
8389
  * @description Constructs the light space component, and associates it with the specified Parent space entity.
8352
8390
  * @param parent - The Space entity that owns this component.
8353
8391
  */
8354
- static create_parent(parent: Multiplayer.SpaceEntity): LightSpaceComponent;
8392
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): LightSpaceComponent;
8355
8393
  /**
8356
8394
  * @description Gets the type of light of this light component.
8357
8395
  * @return The type of light of this light component.
@@ -8515,7 +8553,7 @@ export declare namespace Multiplayer {
8515
8553
  * @description Constructs the portal space component, and associates it with the specified Parent space entity.
8516
8554
  * @param parent - The Space entity that owns this component.
8517
8555
  */
8518
- static create_parent(parent: Multiplayer.SpaceEntity): PortalSpaceComponent;
8556
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): PortalSpaceComponent;
8519
8557
  /**
8520
8558
  * @description Retrieves the space ID that this portal points to.
8521
8559
  * NOTE: When the user uses the portal, it should be able to leave the current space and enter the one
@@ -8561,14 +8599,6 @@ export declare namespace Multiplayer {
8561
8599
  @copydoc IEnableableComponent::SetIsEnabled()
8562
8600
  */
8563
8601
  setIsEnabled(value: boolean): void;
8564
- /**
8565
- @}
8566
- * @description Retrieves the space thumbnail information associated with the space.
8567
- * If the space does not have a thumbnail associated with it the result callback will be successful, the
8568
- * HTTP res code will be ResponseNotFound and the Uri field inside the UriResult will be empty.
8569
- * @param callback - Callback when asynchronous task finishes
8570
- */
8571
- getSpaceThumbnail(): Promise<Systems.UriResult>;
8572
8602
  delete(): void;
8573
8603
  }
8574
8604
  }
@@ -8585,7 +8615,7 @@ export declare namespace Multiplayer {
8585
8615
  * @description Constructs the reflection component, and associates it with the specified Parent space entity.
8586
8616
  * @param parent - The Space entity that owns this component.
8587
8617
  */
8588
- static create_parent(parent: Multiplayer.SpaceEntity): ReflectionSpaceComponent;
8618
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): ReflectionSpaceComponent;
8589
8619
  /**
8590
8620
  * @description Get the name of the Reflection component.
8591
8621
  * @return Csp::common::string specifying the component name.
@@ -8687,7 +8717,7 @@ export declare namespace Multiplayer {
8687
8717
  * @description Constructs the script space component, and associates it with the specified Parent space entity.
8688
8718
  * @param parent - The Space entity that owns this component.
8689
8719
  */
8690
- static create_parent(parent: Multiplayer.SpaceEntity): ScriptSpaceComponent;
8720
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): ScriptSpaceComponent;
8691
8721
  /**
8692
8722
  * @description Retrieves the source of the script of this script component.
8693
8723
  * @return The script source of this script component.
@@ -8730,7 +8760,7 @@ export declare namespace Multiplayer {
8730
8760
  * @description Constructs the spline space component, and associates it with the specified Parent space entity.
8731
8761
  * @param parent - The Space entity that owns this component.
8732
8762
  */
8733
- static create_parent(parent: Multiplayer.SpaceEntity): SplineSpaceComponent;
8763
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): SplineSpaceComponent;
8734
8764
  /**
8735
8765
  * @description Generate a vector3 at a chosen position along the spline
8736
8766
  * Note: Generates a cubic spline position from current Waypoints
@@ -8768,7 +8798,7 @@ export declare namespace Multiplayer {
8768
8798
  * @description Constructs the static model space component, and associates it with the specified Parent space entity.
8769
8799
  * @param parent - The Space entity that owns this component.
8770
8800
  */
8771
- static create_parent(parent: Multiplayer.SpaceEntity): StaticModelSpaceComponent;
8801
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): StaticModelSpaceComponent;
8772
8802
  /** @deprecated
8773
8803
  Due to the introduction of LODs it doesn't make sense to set a specific asset anymore
8774
8804
  */
@@ -8899,7 +8929,7 @@ export declare namespace Multiplayer {
8899
8929
  * @description Constructs the text space component, and associates it with the specified Parent space entity.
8900
8930
  * @param parent - The Space entity that owns this component.
8901
8931
  */
8902
- static create_parent(parent: Multiplayer.SpaceEntity): TextSpaceComponent;
8932
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): TextSpaceComponent;
8903
8933
  /**
8904
8934
  * @description Gets the text this text component refers to.
8905
8935
  * @return The text this text component refers to.
@@ -9041,7 +9071,7 @@ export declare namespace Multiplayer {
9041
9071
  * @description Constructs the video player component, and associates it with the specified Parent space entity.
9042
9072
  * @param parent - The Space entity that owns this component.
9043
9073
  */
9044
- static create_parent(parent: Multiplayer.SpaceEntity): VideoPlayerSpaceComponent;
9074
+ static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): VideoPlayerSpaceComponent;
9045
9075
  /**
9046
9076
  * @description Gets the name of this video player.
9047
9077
  * @return The name of this video player.
@@ -10606,7 +10636,7 @@ export declare namespace Systems {
10606
10636
  /** @internal */
10607
10637
  constructor(pointer: NativePointer);
10608
10638
  static fromSystemBase(baseInstance: Systems.SystemBase): Systems.HotspotSequenceSystem;
10609
- static create_sequenceSystem_spaceSystem_eventBus(sequenceSystem: Systems.SequenceSystem, spaceSystem: Systems.SpaceSystem, eventBus: Multiplayer.EventBus): HotspotSequenceSystem;
10639
+ static create_sequenceSystem_spaceSystem_eventBus_logSystem(sequenceSystem: Systems.SequenceSystem, spaceSystem: Systems.SpaceSystem, eventBus: Multiplayer.EventBus, logSystem: Common.LogSystem): HotspotSequenceSystem;
10610
10640
  /**
10611
10641
  * @description Create a Hotspot group
10612
10642
  * @param groupName - The unique grouping name
@@ -10649,10 +10679,11 @@ export declare namespace Systems {
10649
10679
  /**
10650
10680
  * @description This will delete any groups which only contain this item
10651
10681
  * For any groups which contanin the given item and additional items, it will just update the group by removing the given item.
10652
- * @param itemName - An item to update all sequences containing.
10682
+ * @param itemID - An item to update all sequences containing. Can be retrieved from a HotspotSpaceComponent via
10683
+ * HotspotSpaceComponent::GetUniqueComponentId
10653
10684
  * @param callback - Callback to call when a response is received
10654
10685
  */
10655
- removeItemFromGroups(itemName: string): Promise<Systems.NullResult>;
10686
+ removeItemFromGroups(itemID: string): Promise<Systems.NullResult>;
10656
10687
  /**
10657
10688
  * @description Sets a callback to be fired when a hotspot sequence is changed.
10658
10689
  * @param callback - Callback to receive data for the hotspot sequence that has been changed.
@@ -10863,6 +10894,38 @@ export declare namespace Systems {
10863
10894
  getTierFeaturesQuota(tierName: Systems.TierNames): Promise<Systems.FeaturesQuotaResult>;
10864
10895
  }
10865
10896
  }
10897
+ export declare namespace Systems {
10898
+ /**
10899
+ * @description A JavaScript based scripting system that can be used to create advanced behaviours and interactions between entities in spaces.
10900
+ */
10901
+ class ScriptSystem extends Common.IJSScriptRunner {
10902
+ /** @internal */
10903
+ constructor(pointer: NativePointer);
10904
+ static fromIJSScriptRunner(baseInstance: Common.IJSScriptRunner): Systems.ScriptSystem;
10905
+ /**
10906
+ * @description Starts up the JavaScript runtime context.
10907
+ */
10908
+ initialise(): void;
10909
+ /**
10910
+ * @description Shuts down and deletes the JavaScript runtime context.
10911
+ */
10912
+ shutdown(): void;
10913
+ /**
10914
+ * @description Attempts to execute a script in a given context.
10915
+ * @param contextId - The context in which to run the script. If the provided context does not exist, the script run will fail.
10916
+ * @param scriptText - The script to execute.
10917
+ * @return A boolean representing success running the script.
10918
+ */
10919
+ runScript(contextId: bigint, scriptText: string): boolean;
10920
+ /**
10921
+ * @description Attempts to execute a script from a given file path in the given context.
10922
+ * @param contextId - The context in which to run the script. If the provided context does not exist, the script run will fail.
10923
+ * @param scriptFilePath - The file path of the script to execute.
10924
+ * @return A boolean representing success running the script.
10925
+ */
10926
+ runScriptFile(contextId: bigint, scriptFilePath: string): boolean;
10927
+ }
10928
+ }
10866
10929
  export declare namespace Systems {
10867
10930
  /**
10868
10931
  @ingroup Sequence System
@@ -11869,7 +11932,7 @@ export declare namespace Systems {
11869
11932
  /** @internal */
11870
11933
  constructor(pointer: NativePointer);
11871
11934
  static fromResultBase(baseInstance: Systems.ResultBase): Systems.LoginStateResult;
11872
- getLoginState(): Systems.LoginState;
11935
+ getLoginState(): Common.LoginState;
11873
11936
  delete(): void;
11874
11937
  }
11875
11938
  }
@@ -11966,7 +12029,7 @@ export declare namespace Systems {
11966
12029
  * @description Get the current login state.
11967
12030
  * @return Current login state
11968
12031
  */
11969
- getLoginState(): Systems.LoginState;
12032
+ getLoginState(): Common.LoginState;
11970
12033
  /**
11971
12034
  * @description Sets a callback that will get fired when the login token has changed as a result of logging in with credentials or with a token or
11972
12035
  * after the Connected Spaces Platform internal system has refreshed the session.