connected-spaces-platform.web 5.20.0 → 5.22.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,6 +72,57 @@ 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 Common {
76
+ /**
77
+ * @description Enum specifying the type of change that occured to an asset.
78
+ */
79
+ enum EAssetChangeType {
80
+ Created = 0,
81
+ Updated = 1,
82
+ MusubiFailed = 2,
83
+ Deleted = 3,
84
+ Invalid = 4,
85
+ Num = 5
86
+ }
87
+ }
88
+ export declare namespace Common {
89
+ /**
90
+ * @description Enum specifying the type of change that occured to a user's permissions whilst in a space.
91
+ */
92
+ enum EPermissionChangeType {
93
+ Created = 0,
94
+ Updated = 1,
95
+ Removed = 2,
96
+ Invalid = 3
97
+ }
98
+ }
99
+ export declare namespace Common {
100
+ enum ESequenceUpdateType {
101
+ Create = 0,
102
+ Update = 1,
103
+ Rename = 2,
104
+ Delete = 3,
105
+ Invalid = 4
106
+ }
107
+ }
108
+ export declare namespace Common {
109
+ /**
110
+ * @description Enum representing the type of a replicated value.
111
+ * These values are serialized and stored as integers.
112
+ * When adding new values, always add to the end
113
+ */
114
+ enum ReplicatedValueType {
115
+ InvalidType = 0,
116
+ Boolean = 1,
117
+ Integer = 2,
118
+ Float = 3,
119
+ String = 4,
120
+ Vector3 = 5,
121
+ Vector4 = 6,
122
+ Vector2 = 7,
123
+ StringMap = 8
124
+ }
125
+ }
75
126
  export declare namespace Common {
76
127
  /**
77
128
  * @description Enum which represents possible login states of a CSP client.
@@ -305,39 +356,6 @@ export declare namespace Multiplayer {
305
356
  Delete = 56
306
357
  }
307
358
  }
308
- export declare namespace Multiplayer {
309
- /**
310
- * @description Enum specifying the type of change that occured to an asset.
311
- */
312
- enum EAssetChangeType {
313
- Created = 0,
314
- Updated = 1,
315
- MusubiFailed = 2,
316
- Deleted = 3,
317
- Invalid = 4,
318
- Num = 5
319
- }
320
- }
321
- export declare namespace Multiplayer {
322
- /**
323
- * @description Enum specifying the type of change that occured to a user's permissions whilst in a space.
324
- */
325
- enum EPermissionChangeType {
326
- Created = 0,
327
- Updated = 1,
328
- Removed = 2,
329
- Invalid = 3
330
- }
331
- }
332
- export declare namespace Multiplayer {
333
- enum ESequenceUpdateType {
334
- Create = 0,
335
- Update = 1,
336
- Rename = 2,
337
- Delete = 3,
338
- Invalid = 4
339
- }
340
- }
341
359
  export declare namespace Multiplayer {
342
360
  /**
343
361
  * @description Enum used to specify the current state of the multiplayer connection.
@@ -370,24 +388,6 @@ export declare namespace Multiplayer {
370
388
  STOP_LISTENING = 13
371
389
  }
372
390
  }
373
- export declare namespace Multiplayer {
374
- /**
375
- * @description Enum representing the type of a replicated value.
376
- * These values are serialized and stored as integers.
377
- * When adding new values, always add to the end
378
- */
379
- enum ReplicatedValueType {
380
- InvalidType = 0,
381
- Boolean = 1,
382
- Integer = 2,
383
- Float = 3,
384
- String = 4,
385
- Vector3 = 5,
386
- Vector4 = 6,
387
- Vector2 = 7,
388
- StringMap = 8
389
- }
390
- }
391
391
  export declare namespace Multiplayer {
392
392
  /**
393
393
  * @description Enum used to specify the the type of a space entity
@@ -1514,7 +1514,7 @@ export declare namespace Systems {
1514
1514
  }
1515
1515
  }
1516
1516
  /**
1517
- * @description Represents definition for identifying and versioning an external service endpoint..
1517
+ * @description Represents definition for identifying and versioning an external service endpoint.
1518
1518
  */
1519
1519
  export declare class ServiceDefinition extends NativeClassWrapper implements INativeResource {
1520
1520
  /** @internal */
@@ -3281,103 +3281,318 @@ export declare namespace Common {
3281
3281
  }
3282
3282
  export declare namespace Common {
3283
3283
  /**
3284
- * @description Variant is an intermediate class that enables clients to pack data into types that are supported by Connected Spaces Platform replication
3285
- * systems.
3284
+ * @description Data deserialized from a general purpose event. Serves as the base type for all custom deserialized events.
3286
3285
  */
3287
- class Variant extends NativeClassWrapper implements INativeResource {
3286
+ class NetworkEventData extends NativeClassWrapper implements INativeResource {
3287
+ /** @internal */
3288
+ constructor(pointer: NativePointer);
3289
+ delete(): void;
3290
+ static create(): NetworkEventData;
3291
+ get eventName(): string;
3292
+ set eventName(value: string);
3293
+ get senderClientId(): bigint;
3294
+ set senderClientId(value: bigint);
3295
+ get eventValues(): Common.Array<Common.ReplicatedValue>;
3296
+ set eventValues(value: Common.Array<Common.ReplicatedValue>);
3297
+ }
3298
+ }
3299
+ export declare namespace Common {
3300
+ class HotspotSequenceChangedNetworkEventData extends NativeClassWrapper implements INativeResource {
3301
+ /** @internal */
3302
+ constructor(pointer: NativePointer);
3303
+ static create(): HotspotSequenceChangedNetworkEventData;
3304
+ delete(): void;
3305
+ get spaceId(): string;
3306
+ set spaceId(value: string);
3307
+ get name(): string;
3308
+ set name(value: string);
3309
+ get newName(): string;
3310
+ set newName(value: string);
3311
+ }
3312
+ }
3313
+ export declare namespace Common {
3314
+ class MaterialChangedParams extends NativeClassWrapper implements INativeResource {
3315
+ /** @internal */
3316
+ constructor(pointer: NativePointer);
3317
+ static create(): MaterialChangedParams;
3318
+ delete(): void;
3319
+ get materialCollectionId(): string;
3320
+ set materialCollectionId(value: string);
3321
+ get materialId(): string;
3322
+ set materialId(value: string);
3323
+ get changeType(): Common.EAssetChangeType;
3324
+ set changeType(value: Common.EAssetChangeType);
3325
+ }
3326
+ }
3327
+ export declare namespace Common {
3328
+ /**
3329
+ * @description ReplicatedValue is an intermediate class that enables clients to pack data into types that are supported by Connected Spaces Platform
3330
+ * replication systems.
3331
+ */
3332
+ class ReplicatedValue extends NativeClassWrapper implements INativeResource {
3288
3333
  /** @internal */
3289
3334
  constructor(pointer: NativePointer);
3290
3335
  /**
3291
- * @description A default Variant will not have a valid type ("VariantType::InvalidType"), and will have no internal value associated.
3292
- * Do not use this constructor unless you know what you are doing!
3336
+ * @description A default ReplicatedValue will not have a valid type ("ReplicatedValueType::InvalidType"), and will have no internal value associated.
3337
+ * /// Do not use this constructor unless you know what you are doing!
3293
3338
  */
3294
- static create(): Variant;
3339
+ static create(): ReplicatedValue;
3295
3340
  /**
3296
- * @description Construct a Variant based on a bool type.
3297
- * @param inBoolValue - In value
3341
+ * @description Construct a ReplicatedValue based on a bool type.
3342
+ * @param inBoolValue - Initial value.
3298
3343
  */
3299
- static create_boolValue(boolValue: boolean): Variant;
3344
+ static create_boolValue(boolValue: boolean): ReplicatedValue;
3300
3345
  /**
3301
- * @description Construct a Variant based on a double-precision float type.
3302
- * @param inFloatValue - In value
3346
+ * @description Construct a ReplicatedValue based on a float type.
3347
+ * @param inFloatValue - Initial value.
3303
3348
  */
3304
- static create_floatValue(floatValue: number): Variant;
3349
+ static create_floatValue(floatValue: number): ReplicatedValue;
3305
3350
  /**
3306
- * @description Construct a Variant based on a Long (uint64_t) type.
3307
- * @param inLongValue - In value
3351
+ * @description Construct a ReplicatedValue based on a Long (uint64_t) type.
3352
+ * @param inLongValue - Initial value.
3308
3353
  */
3309
- static create_longValue(longValue: bigint): Variant;
3354
+ static create_longValue(longValue: bigint): ReplicatedValue;
3310
3355
  /**
3311
- * @description Construct a Variant based on an csp::common::String type.
3312
- * @param inStringValue - In value
3356
+ * @description Construct a ReplicatedValue based on an csp::common::String type.
3357
+ * @param inStringValue - Initial value.
3313
3358
  */
3314
- static create_stringValue(stringValue: string): Variant;
3359
+ static create_stringValue(stringValue: string): ReplicatedValue;
3315
3360
  /**
3316
- * @description Construct a Variant based on a csp::common::Vector3 type.
3317
- * @param inVector3Value - In value
3361
+ * @description Construct a ReplicatedValue based on a csp::common::Vector2 type.
3362
+ * @param inVector2Value - Initial value.
3318
3363
  */
3319
- static create_vector3Value(vector3Value: Common.Vector3): Variant;
3364
+ static create_vector2Value(vector2Value: Common.Vector2): ReplicatedValue;
3320
3365
  /**
3321
- * @description Construct a Variant based on an csp::common::Vector4 type.
3322
- * @param inVector4Value - In value
3366
+ * @description Construct a ReplicatedValue based on a csp::common::Vector3 type.
3367
+ * @param inVector3Value - Initial value.
3323
3368
  */
3324
- static create_vector4Value(vector4Value: Common.Vector4): Variant;
3369
+ static create_vector3Value(vector3Value: Common.Vector3): ReplicatedValue;
3370
+ /**
3371
+ * @description Construct a ReplicatedValue based on an csp::common::Vector4 type.
3372
+ * @param inVector4Value - Initial value.
3373
+ */
3374
+ static create_vector4Value(vector4Value: Common.Vector4): ReplicatedValue;
3375
+ /**
3376
+ * @description Construct a ReplicatedValue based on an csp::common::Map type with a string value as the key.
3377
+ * @param inMapValue - Initial value.
3378
+ */
3379
+ static create_mapValue(mapValue: Common.Map<string, Common.ReplicatedValue>): ReplicatedValue;
3325
3380
  /**
3326
3381
  * @description Copy constructor
3327
- * @param other - Const variant&
3382
+ * @param other - The value to copy.
3328
3383
  */
3329
- static create_other(other: Common.Variant): Variant;
3384
+ static create_other(other: Common.ReplicatedValue): ReplicatedValue;
3330
3385
  /**
3331
- * @description Destructor
3386
+ * @description Destroys the replicated value instance.
3332
3387
  */
3333
3388
  delete(): void;
3389
+ /**
3390
+ * @description Assignment operator overload.
3391
+ * @param inValue - Other replicated value to set this one to.
3392
+ */
3393
+ /**
3394
+ * @description Equality operator overload.
3395
+ * @param replicatedValue - Other value to compare to.
3396
+ */
3397
+ /**
3398
+ * @description Non equality operator overload.
3399
+ * @param replicatedValue - Other value to compare to.
3400
+ */
3401
+ /**
3402
+ * @description Less than operator overload.
3403
+ * @param replicatedValue - Other value to compare to.
3404
+ */
3405
+ /**
3406
+ * @description Greater than operator overload.
3407
+ * @param replicatedValue - Other value to compare to.
3408
+ */
3334
3409
  /**
3335
3410
  * @description Gets the type of replicated value.
3336
- * @return The current variant internal type
3411
+ * @return Enum representing all supported replication base types.
3337
3412
  */
3338
- getValueType(): Common.VariantType;
3413
+ getReplicatedValueType(): Common.ReplicatedValueType;
3339
3414
  /**
3340
- * @description Sets internal variant type as a bool.
3415
+ * @description Sets a bool value for this replicated value, will overwrite any previous value.
3416
+ * @param inValu - InValue
3341
3417
  */
3342
3418
  setBool(value: boolean): void;
3343
3419
  /**
3344
- * @description Gets internal variant type as a bool.
3345
- * @return Bool
3420
+ * @description Get a bool value from this replicated value, will assert if not a bool type.
3421
+ * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3422
+ * /// @return bool
3346
3423
  */
3347
3424
  getBool(): boolean;
3348
3425
  /**
3349
- * @description Sets internal variant type as a double-precision float.
3426
+ * @description Sets a float value for this replicated value, will overwrite any previous value.
3427
+ * @param inValu - InValue
3350
3428
  */
3351
3429
  setFloat(value: number): void;
3352
3430
  /**
3353
- * @description Gets internal variant type as a double-precision float.
3354
- * @return Double
3431
+ * @description Get a float value from this replicated value, will assert if not a float type.
3432
+ * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3433
+ * /// @return float value
3355
3434
  */
3356
3435
  getFloat(): number;
3357
3436
  /**
3358
- * @description Sets internal variant type as an int64_t.
3437
+ * @description Sets a int64 value for this replicated value, will overwrite any previous value.
3438
+ * @param inValu - InValue
3359
3439
  */
3360
3440
  setInt(value: bigint): void;
3361
3441
  /**
3362
- * @description Gets internal variant type as a int64_t.
3363
- * @return Int16_t
3442
+ * @description Get a int64 value from this replicated value, will assert if not a int64 type.
3443
+ * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3444
+ * /// @return int64 value
3364
3445
  */
3365
3446
  getInt(): bigint;
3366
- /**
3367
- * @description Sets internal variant type as a String.
3368
- */
3369
3447
  setString(value: string): void;
3370
3448
  /**
3371
- * @description Gets internal variant type as a String.
3372
- * @return Const csp::common::string&
3449
+ * @description Get a csp::common::String& value from this replicated value, will assert if not a csp::common::String type.
3450
+ * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3451
+ * /// @return csp::common::String&
3373
3452
  */
3374
3453
  getString(): string;
3375
3454
  /**
3376
- * @description Sets internal variant type as a Vector3.
3455
+ * @description Set a Vector2 value for this replicated value from a csp::common::Vector2, will overwrite and previous value.
3377
3456
  */
3378
- setVector3(value: Common.Vector3): void;
3457
+ setVector2(value: Common.Vector2): void;
3379
3458
  /**
3380
- * @description Gets internal variant type as a Vector3.
3459
+ * @description Get a csp::common::Vector2 value from this replicated value, will assert if not a csp::common::Vector2 type.
3460
+ * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3461
+ * /// @return csp::common::Vector2
3462
+ */
3463
+ getVector2(): Common.Vector2;
3464
+ /**
3465
+ * @description Set a Vector3 value for this replicated value from a csp::common::Vector3, will overwrite and previous value.
3466
+ */
3467
+ setVector3(value: Common.Vector3): void;
3468
+ /**
3469
+ * @description Get a csp::common::Vector3 value from this replicated value, will assert if not a csp::common::Vector3 type.
3470
+ * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3471
+ * /// @return csp::common::Vector3
3472
+ */
3473
+ getVector3(): Common.Vector3;
3474
+ /**
3475
+ * @description Set a Vector4 value for this replicated value from a csp::common::Vector4, will overwrite and previous value.
3476
+ */
3477
+ setVector4(value: Common.Vector4): void;
3478
+ /**
3479
+ * @description Get a csp::common::Vector4 value from this replicated value, will assert if not a csp::common::Vector4 type.
3480
+ * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3481
+ * /// @return csp::common::Vector4
3482
+ */
3483
+ getVector4(): Common.Vector4;
3484
+ /**
3485
+ * @description Get a csp::common::Map value with a string value as the key.
3486
+ * This will assert if not a csp::common::Map type with a string value as the key.
3487
+ * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3488
+ * /// @return csp::common::Map
3489
+ */
3490
+ getStringMap(): Common.Map<string, Common.ReplicatedValue>;
3491
+ /**
3492
+ * @description Set a string Map value for this replicated value from a csp::common::Map, will overwrite any previous value.
3493
+ */
3494
+ setStringMap(value: Common.Map<string, Common.ReplicatedValue>): void;
3495
+ }
3496
+ }
3497
+ export declare namespace Common {
3498
+ /**
3499
+ * @description Variant is an intermediate class that enables clients to pack data into types that are supported by Connected Spaces Platform replication
3500
+ * systems.
3501
+ */
3502
+ class Variant extends NativeClassWrapper implements INativeResource {
3503
+ /** @internal */
3504
+ constructor(pointer: NativePointer);
3505
+ /**
3506
+ * @description A default Variant will not have a valid type ("VariantType::InvalidType"), and will have no internal value associated.
3507
+ * Do not use this constructor unless you know what you are doing!
3508
+ */
3509
+ static create(): Variant;
3510
+ /**
3511
+ * @description Construct a Variant based on a bool type.
3512
+ * @param inBoolValue - In value
3513
+ */
3514
+ static create_boolValue(boolValue: boolean): Variant;
3515
+ /**
3516
+ * @description Construct a Variant based on a double-precision float type.
3517
+ * @param inFloatValue - In value
3518
+ */
3519
+ static create_floatValue(floatValue: number): Variant;
3520
+ /**
3521
+ * @description Construct a Variant based on a Long (uint64_t) type.
3522
+ * @param inLongValue - In value
3523
+ */
3524
+ static create_longValue(longValue: bigint): Variant;
3525
+ /**
3526
+ * @description Construct a Variant based on an csp::common::String type.
3527
+ * @param inStringValue - In value
3528
+ */
3529
+ static create_stringValue(stringValue: string): Variant;
3530
+ /**
3531
+ * @description Construct a Variant based on a csp::common::Vector3 type.
3532
+ * @param inVector3Value - In value
3533
+ */
3534
+ static create_vector3Value(vector3Value: Common.Vector3): Variant;
3535
+ /**
3536
+ * @description Construct a Variant based on an csp::common::Vector4 type.
3537
+ * @param inVector4Value - In value
3538
+ */
3539
+ static create_vector4Value(vector4Value: Common.Vector4): Variant;
3540
+ /**
3541
+ * @description Copy constructor
3542
+ * @param other - Const variant&
3543
+ */
3544
+ static create_other(other: Common.Variant): Variant;
3545
+ /**
3546
+ * @description Destructor
3547
+ */
3548
+ delete(): void;
3549
+ /**
3550
+ * @description Gets the type of replicated value.
3551
+ * @return The current variant internal type
3552
+ */
3553
+ getValueType(): Common.VariantType;
3554
+ /**
3555
+ * @description Sets internal variant type as a bool.
3556
+ */
3557
+ setBool(value: boolean): void;
3558
+ /**
3559
+ * @description Gets internal variant type as a bool.
3560
+ * @return Bool
3561
+ */
3562
+ getBool(): boolean;
3563
+ /**
3564
+ * @description Sets internal variant type as a double-precision float.
3565
+ */
3566
+ setFloat(value: number): void;
3567
+ /**
3568
+ * @description Gets internal variant type as a double-precision float.
3569
+ * @return Double
3570
+ */
3571
+ getFloat(): number;
3572
+ /**
3573
+ * @description Sets internal variant type as an int64_t.
3574
+ */
3575
+ setInt(value: bigint): void;
3576
+ /**
3577
+ * @description Gets internal variant type as a int64_t.
3578
+ * @return Int16_t
3579
+ */
3580
+ getInt(): bigint;
3581
+ /**
3582
+ * @description Sets internal variant type as a String.
3583
+ */
3584
+ setString(value: string): void;
3585
+ /**
3586
+ * @description Gets internal variant type as a String.
3587
+ * @return Const csp::common::string&
3588
+ */
3589
+ getString(): string;
3590
+ /**
3591
+ * @description Sets internal variant type as a Vector3.
3592
+ */
3593
+ setVector3(value: Common.Vector3): void;
3594
+ /**
3595
+ * @description Gets internal variant type as a Vector3.
3381
3596
  * @return Csp::common::vector3
3382
3597
  */
3383
3598
  getVector3(): Common.Vector3;
@@ -3809,7 +4024,7 @@ export declare namespace Multiplayer {
3809
4024
  * intended to be defined in the inherited component as an enum of available properties keys.
3810
4025
  * /// @return A map of the replicated values, keyed by their unique key.
3811
4026
  */
3812
- getProperties(): Common.Map<number, Multiplayer.ReplicatedValue>;
4027
+ getProperties(): Common.Map<number, Common.ReplicatedValue>;
3813
4028
  /**
3814
4029
  * @description Get the parent SpaceEntity for this component. Components can only attach to one parent.
3815
4030
  * @return A pointer to the parent SpaceEntity.
@@ -3822,387 +4037,176 @@ export declare namespace Multiplayer {
3822
4037
  * a pointer to this component, the name of the action and a string of parameters for the action.
3823
4038
  */
3824
4039
  registerActionHandler(action: string, actionHandler: (arg1: Multiplayer.ComponentBase, arg2: string, arg3: string) => void): void;
3825
- /**
3826
- * @description Removes the action handler callback for the given action.
3827
- * @param inAction - The identifying name of the action.
3828
- */
3829
- unregisterActionHandler(action: string): void;
3830
- /**
3831
- * @description Calls the registered action handler callback for the given action and passes the given parameters.
3832
- * @param inAction - The identifying name of the action.
3833
- * @param inActionParams - Parameters for the action that will be passed to the action handler callback.
3834
- */
3835
- invokeAction(action: string, actionParams: string): void;
3836
- /**
3837
- * @description Gets the name of the component.
3838
- */
3839
- getComponentName(): string;
3840
- /**
3841
- * @description Sets the name for the component.
3842
- * @param value - - The new name to assign to the componenent.
3843
- */
3844
- setComponentName(value: string): void;
3845
- }
3846
- }
3847
- export declare namespace Multiplayer {
3848
- /**
3849
- @ingroup Multiplayer
3850
- * @description Handling of all network events.
3851
- */
3852
- class EventBus extends NativeClassWrapper implements INativeResource {
3853
- /** @internal */
3854
- constructor(pointer: NativePointer);
3855
- /**
3856
- * @description Sends a network event by EventName to all currently connected clients.
3857
- * @param eventName - The identifying name for the event.
3858
- * @param args - An array of arguments (ReplicatedValue) to be passed as part of the event payload.
3859
- * @param callback - A callback with failure state.
3860
- */
3861
- sendNetworkEvent(eventName: string, args: Common.Array<Multiplayer.ReplicatedValue>): Promise<Multiplayer.ErrorCode>;
3862
- /**
3863
- * @description Sends a network event by EventName, to TargetClientId.
3864
- * @param eventName - The identifying name for the event.
3865
- * @param args - An array of arguments (ReplicatedValue) to be passed as part of the event payload.
3866
- * @param targetClientId - The client ID to send the event to.
3867
- * @param callback - A callback with failure state.
3868
- */
3869
- sendNetworkEventToClient(eventName: string, args: Common.Array<Multiplayer.ReplicatedValue>, targetClientId: bigint): Promise<Multiplayer.ErrorCode>;
3870
- /**
3871
- * @description Registers a callback to listen for the named event
3872
- * @param eventName - The identifying name for the event to listen for.
3873
- * @param callback - A callback to register for the event which contains the parameter payload data.
3874
- */
3875
- listenNetworkEvent(eventName: string, callback: (arg1: boolean, arg2: Common.Array<Multiplayer.ReplicatedValue>) => void): void;
3876
- /**
3877
- * @description Stops the event bus from listening for a particular event, for any system or callback
3878
- * @description that were registered.
3879
- * @param eventName - The identifying name for the event to stop listening for.
3880
- */
3881
- stopListenNetworkEvent(eventName: string): void;
3882
- /**
3883
- * @description Instructs the event bus to start listening to messages
3884
- */
3885
- startEventMessageListening(): void;
3886
- delete(): void;
3887
- }
3888
- }
3889
- export declare namespace Multiplayer {
3890
- /**
3891
- * @description Describes the changes an asset has undergone when the client application is connected to a space.
3892
- */
3893
- class AssetDetailBlobParams extends NativeClassWrapper implements INativeResource {
3894
- /** @internal */
3895
- constructor(pointer: NativePointer);
3896
- static create(): AssetDetailBlobParams;
3897
- delete(): void;
3898
- get changeType(): Multiplayer.EAssetChangeType;
3899
- set changeType(value: Multiplayer.EAssetChangeType);
3900
- get assetId(): string;
3901
- set assetId(value: string);
3902
- get version(): string;
3903
- set version(value: string);
3904
- get assetType(): Systems.EAssetType;
3905
- set assetType(value: Systems.EAssetType);
3906
- get assetCollectionId(): string;
3907
- set assetCollectionId(value: string);
3908
- }
3909
- }
3910
- export declare namespace Multiplayer {
3911
- /**
3912
- * @description Class used to provide details of a conversation message that has been received whilst the client application is connected to a space.
3913
- */
3914
- class ConversationEventParams extends NativeClassWrapper implements INativeResource {
3915
- /** @internal */
3916
- constructor(pointer: NativePointer);
3917
- static create(): ConversationEventParams;
3918
- delete(): void;
3919
- get messageType(): Multiplayer.ConversationEventType;
3920
- set messageType(value: Multiplayer.ConversationEventType);
3921
- get messageInfo(): Multiplayer.MessageInfo;
3922
- set messageInfo(value: Multiplayer.MessageInfo);
3923
- }
3924
- }
3925
- export declare namespace Multiplayer {
3926
- /**
3927
- * @description Class used to provide details of a permission change that has happened to a user whilst the client application is connected to a space.
3928
- */
3929
- class UserPermissionsParams extends NativeClassWrapper implements INativeResource {
3930
- /** @internal */
3931
- constructor(pointer: NativePointer);
3932
- static create(): UserPermissionsParams;
3933
- delete(): void;
3934
- get spaceId(): string;
3935
- set spaceId(value: string);
3936
- get userRoles(): Common.Array<Systems.SpaceUserRole>;
3937
- set userRoles(value: Common.Array<Systems.SpaceUserRole>);
3938
- get changeType(): Multiplayer.EPermissionChangeType;
3939
- set changeType(value: Multiplayer.EPermissionChangeType);
3940
- get userId(): string;
3941
- set userId(value: string);
3942
- }
3943
- }
3944
- export declare namespace Multiplayer {
3945
- class SequenceChangedParams extends NativeClassWrapper implements INativeResource {
3946
- /** @internal */
3947
- constructor(pointer: NativePointer);
3948
- static create(): SequenceChangedParams;
3949
- delete(): void;
3950
- get updateType(): Multiplayer.ESequenceUpdateType;
3951
- set updateType(value: Multiplayer.ESequenceUpdateType);
3952
- get key(): string;
3953
- set key(value: string);
3954
- get newKey(): string;
3955
- set newKey(value: string);
3956
- }
3957
- }
3958
- export declare namespace Multiplayer {
3959
- class SequenceHotspotChangedParams extends NativeClassWrapper implements INativeResource {
3960
- /** @internal */
3961
- constructor(pointer: NativePointer);
3962
- static create(): SequenceHotspotChangedParams;
3963
- delete(): void;
3964
- get updateType(): Multiplayer.ESequenceUpdateType;
3965
- set updateType(value: Multiplayer.ESequenceUpdateType);
3966
- get spaceId(): string;
3967
- set spaceId(value: string);
3968
- get name(): string;
3969
- set name(value: string);
3970
- get newName(): string;
3971
- set newName(value: string);
3972
- }
3973
- }
3974
- export declare namespace Multiplayer {
3975
- class MaterialChangedParams extends NativeClassWrapper implements INativeResource {
3976
- /** @internal */
3977
- constructor(pointer: NativePointer);
3978
- static create(): MaterialChangedParams;
3979
- delete(): void;
3980
- get materialCollectionId(): string;
3981
- set materialCollectionId(value: string);
3982
- get materialId(): string;
3983
- set materialId(value: string);
3984
- get changeType(): Multiplayer.EAssetChangeType;
3985
- set changeType(value: Multiplayer.EAssetChangeType);
3986
- }
3987
- }
3988
- export declare namespace Multiplayer {
3989
- /**
3990
- @ingroup Multiplayer
3991
- * @description Handling of all multiplayer connection functionality, such as connect, disconnect, entity replication and network events.
3992
- */
3993
- class MultiplayerConnection extends NativeClassWrapper implements INativeResource {
3994
- /** @internal */
3995
- constructor(pointer: NativePointer);
3996
- /**
3997
- * @description Sets a callback for a disconnection event.
3998
- * @param callback - The callback for disconnection, contains a string with a reason for disconnection.
3999
- */
4000
- setDisconnectionCallback(callback: (arg1: string) => void): void;
4001
- /**
4002
- * @description Sets a callback for a connection event
4003
- * @param callback - The callback for connection, contains a string with a status of connection (Success, Failure etc).
4004
- */
4005
- setConnectionCallback(callback: (arg1: string) => void): void;
4006
- /**
4007
- * @description Sets a callback for a network interruption event.
4008
- * Connection isn't recoverable after this point and Disconnect should be called.
4009
- * @param callback - The callback for network interruption, contains a string showing failure.
4010
- */
4011
- setNetworkInterruptionCallback(callback: (arg1: string) => void): void;
4012
- /**
4013
- * @description Requests the ClientID.
4014
- * @return Uint64_t the clientid for this connection.
4015
- */
4016
- getClientId(): bigint;
4017
- /**
4018
- * @description Gets the current connection state.
4019
- * @return A ConnectionState enum value.
4020
- */
4021
- getConnectionState(): Multiplayer.ConnectionState;
4022
- /**
4023
- * @description Sets the Self Messaging flag for this client.
4024
- * This allows a client to declare that it wishes to receive every patch and object message it sends.
4025
- @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!
4026
- * @param allowSelfMessaging - True to allow and false to disallow.
4027
- * @param callback - A callback with failure state.
4028
- */
4029
- setAllowSelfMessagingFlag(allowSelfMessaging: boolean): Promise<Multiplayer.ErrorCode>;
4030
- /**
4031
- * @description Gets the bool representing if we're using self-messaging or not.
4032
- * @return True if self messaging is allowed, false otherwise.
4033
- */
4034
- getAllowSelfMessagingFlag(): boolean;
4035
- delete(): void;
4036
- }
4037
- }
4038
- export declare namespace Multiplayer {
4039
- /**
4040
- * @description ReplicatedValue is an intermediate class that enables clients to pack data into types that are supported by Connected Spaces Platform
4041
- * replication systems.
4042
- */
4043
- class ReplicatedValue extends NativeClassWrapper implements INativeResource {
4044
- /** @internal */
4045
- constructor(pointer: NativePointer);
4046
- /**
4047
- * @description A default ReplicatedValue will not have a valid type ("ReplicatedValueType::InvalidType"), and will have no internal value associated.
4048
- * /// Do not use this constructor unless you know what you are doing!
4049
- */
4050
- static create(): ReplicatedValue;
4051
- /**
4052
- * @description Construct a ReplicatedValue based on a bool type.
4053
- * @param inBoolValue - Initial value.
4054
- */
4055
- static create_boolValue(boolValue: boolean): ReplicatedValue;
4056
- /**
4057
- * @description Construct a ReplicatedValue based on a float type.
4058
- * @param inFloatValue - Initial value.
4059
- */
4060
- static create_floatValue(floatValue: number): ReplicatedValue;
4061
- /**
4062
- * @description Construct a ReplicatedValue based on a Long (uint64_t) type.
4063
- * @param inLongValue - Initial value.
4064
- */
4065
- static create_longValue(longValue: bigint): ReplicatedValue;
4066
- /**
4067
- * @description Construct a ReplicatedValue based on an csp::common::String type.
4068
- * @param inStringValue - Initial value.
4069
- */
4070
- static create_stringValue(stringValue: string): ReplicatedValue;
4071
- /**
4072
- * @description Construct a ReplicatedValue based on a csp::common::Vector2 type.
4073
- * @param inVector2Value - Initial value.
4074
- */
4075
- static create_vector2Value(vector2Value: Common.Vector2): ReplicatedValue;
4076
- /**
4077
- * @description Construct a ReplicatedValue based on a csp::common::Vector3 type.
4078
- * @param inVector3Value - Initial value.
4079
- */
4080
- static create_vector3Value(vector3Value: Common.Vector3): ReplicatedValue;
4081
- /**
4082
- * @description Construct a ReplicatedValue based on an csp::common::Vector4 type.
4083
- * @param inVector4Value - Initial value.
4084
- */
4085
- static create_vector4Value(vector4Value: Common.Vector4): ReplicatedValue;
4086
- /**
4087
- * @description Construct a ReplicatedValue based on an csp::common::Map type with a string value as the key.
4088
- * @param inMapValue - Initial value.
4089
- */
4090
- static create_mapValue(mapValue: Common.Map<string, Multiplayer.ReplicatedValue>): ReplicatedValue;
4091
- /**
4092
- * @description Copy constructor
4093
- * @param other - The value to copy.
4094
- */
4095
- static create_other(other: Multiplayer.ReplicatedValue): ReplicatedValue;
4096
- /**
4097
- * @description Destroys the replicated value instance.
4098
- */
4099
- delete(): void;
4100
- /**
4101
- * @description Assignment operator overload.
4102
- * @param inValue - Other replicated value to set this one to.
4103
- */
4104
- /**
4105
- * @description Equality operator overload.
4106
- * @param replicatedValue - Other value to compare to.
4040
+ /**
4041
+ * @description Removes the action handler callback for the given action.
4042
+ * @param inAction - The identifying name of the action.
4107
4043
  */
4044
+ unregisterActionHandler(action: string): void;
4108
4045
  /**
4109
- * @description Non equality operator overload.
4110
- * @param replicatedValue - Other value to compare to.
4046
+ * @description Calls the registered action handler callback for the given action and passes the given parameters.
4047
+ * @param inAction - The identifying name of the action.
4048
+ * @param inActionParams - Parameters for the action that will be passed to the action handler callback.
4111
4049
  */
4050
+ invokeAction(action: string, actionParams: string): void;
4112
4051
  /**
4113
- * @description Less than operator overload.
4114
- * @param replicatedValue - Other value to compare to.
4052
+ * @description Gets the name of the component.
4115
4053
  */
4054
+ getComponentName(): string;
4116
4055
  /**
4117
- * @description Greater than operator overload.
4118
- * @param replicatedValue - Other value to compare to.
4056
+ * @description Sets the name for the component.
4057
+ * @param value - - The new name to assign to the componenent.
4119
4058
  */
4059
+ setComponentName(value: string): void;
4060
+ }
4061
+ }
4062
+ export declare namespace Multiplayer {
4063
+ /**
4064
+ * @description CSPSceneDescription which represents all entities that exists for a scene.
4065
+ @details This data structure is created through the deserialization of a CSPSceneDescription Json which is retrieved externally.
4066
+ * The json file used to create this structure is also used to create a systems::CSPSceneData object.
4067
+ * The reason these are seperated is to break dependencies between our multiplayer and corer modules.
4068
+ */
4069
+ class CSPSceneDescription extends NativeClassWrapper implements INativeResource {
4070
+ /** @internal */
4071
+ constructor(pointer: NativePointer);
4120
4072
  /**
4121
- * @description Gets the type of replicated value.
4122
- * @return Enum representing all supported replication base types.
4073
+ * @description Constructor for CSPSceneDescription by deserializing a SceneDescription json file.
4074
+ * @param sceneDescriptionJson - The SceneDescription to deserialize.
4075
+ * @param entitySystem - The SpaceEntitySystem for this session.
4076
+ * @param logSystem - The SpaceEntitySystem for this session.
4077
+ * @param remoteScriptRunner - The ScriptRunner for this session.
4123
4078
  */
4124
- getReplicatedValueType(): Multiplayer.ReplicatedValueType;
4079
+ static create_sceneDescriptionJson_entitySystem_logSystem_remoteScriptRunner(sceneDescriptionJson: string, entitySystem: Multiplayer.SpaceEntitySystem, logSystem: Common.LogSystem, remoteScriptRunner: Common.IJSScriptRunner): CSPSceneDescription;
4080
+ delete(): void;
4081
+ get entities(): Common.Array<Multiplayer.SpaceEntity>;
4082
+ set entities(value: Common.Array<Multiplayer.SpaceEntity>);
4083
+ }
4084
+ }
4085
+ export declare namespace Multiplayer {
4086
+ /**
4087
+ @ingroup Multiplayer
4088
+ * @description Handling of all multiplayer connection functionality, such as connect, disconnect, entity replication and network events.
4089
+ */
4090
+ class MultiplayerConnection extends NativeClassWrapper implements INativeResource {
4091
+ /** @internal */
4092
+ constructor(pointer: NativePointer);
4125
4093
  /**
4126
- * @description Sets a bool value for this replicated value, will overwrite any previous value.
4127
- * @param inValu - InValue
4094
+ * @description Sets a callback for a disconnection event.
4095
+ * @param callback - The callback for disconnection, contains a string with a reason for disconnection.
4128
4096
  */
4129
- setBool(value: boolean): void;
4097
+ setDisconnectionCallback(callback: (arg1: string) => void): void;
4130
4098
  /**
4131
- * @description Get a bool value from this replicated value, will assert if not a bool type.
4132
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
4133
- * /// @return bool
4099
+ * @description Sets a callback for a connection event
4100
+ * @param callback - The callback for connection, contains a string with a status of connection (Success, Failure etc).
4134
4101
  */
4135
- getBool(): boolean;
4102
+ setConnectionCallback(callback: (arg1: string) => void): void;
4136
4103
  /**
4137
- * @description Sets a float value for this replicated value, will overwrite any previous value.
4138
- * @param inValu - InValue
4104
+ * @description Sets a callback for a network interruption event.
4105
+ * Connection isn't recoverable after this point and Disconnect should be called.
4106
+ * @param callback - The callback for network interruption, contains a string showing failure.
4139
4107
  */
4140
- setFloat(value: number): void;
4108
+ setNetworkInterruptionCallback(callback: (arg1: string) => void): void;
4141
4109
  /**
4142
- * @description Get a float value from this replicated value, will assert if not a float type.
4143
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
4144
- * /// @return float value
4110
+ * @description Requests the ClientID.
4111
+ * @return Uint64_t the clientid for this connection.
4145
4112
  */
4146
- getFloat(): number;
4113
+ getClientId(): bigint;
4147
4114
  /**
4148
- * @description Sets a int64 value for this replicated value, will overwrite any previous value.
4149
- * @param inValu - InValue
4115
+ * @description Gets the current connection state.
4116
+ * @return A ConnectionState enum value.
4150
4117
  */
4151
- setInt(value: bigint): void;
4118
+ getConnectionState(): Multiplayer.ConnectionState;
4152
4119
  /**
4153
- * @description Get a int64 value from this replicated value, will assert if not a int64 type.
4154
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
4155
- * /// @return int64 value
4120
+ * @description Sets the Self Messaging flag for this client.
4121
+ * This allows a client to declare that it wishes to receive every patch and object message it sends.
4122
+ @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!
4123
+ * @param allowSelfMessaging - True to allow and false to disallow.
4124
+ * @param callback - A callback with failure state.
4156
4125
  */
4157
- getInt(): bigint;
4158
- setString(value: string): void;
4126
+ setAllowSelfMessagingFlag(allowSelfMessaging: boolean): Promise<Multiplayer.ErrorCode>;
4159
4127
  /**
4160
- * @description Get a csp::common::String& value from this replicated value, will assert if not a csp::common::String type.
4161
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
4162
- * /// @return csp::common::String&
4128
+ * @description Gets the bool representing if we're using self-messaging or not.
4129
+ * @return True if self messaging is allowed, false otherwise.
4163
4130
  */
4164
- getString(): string;
4131
+ getAllowSelfMessagingFlag(): boolean;
4132
+ delete(): void;
4133
+ }
4134
+ }
4135
+ export declare namespace Multiplayer {
4136
+ class NetworkEventRegistration extends NativeClassWrapper implements INativeResource {
4137
+ /** @internal */
4138
+ constructor(pointer: NativePointer);
4165
4139
  /**
4166
- * @description Set a Vector2 value for this replicated value from a csp::common::Vector2, will overwrite and previous value.
4140
+ * @description Construct a NetworkEventRegistration
4141
+ * @param eventReceiverId - The identifying name for the event receiver, used for management purposes, allowing clients to
4142
+ * register multiple interests in single events. May be any arbitrary unique string. This is distinct from client ID. A single client/application
4143
+ * may register multiple receivers if they choose.
4144
+ * @param eventName - The identifying name for the event. May be any arbitrary string.
4167
4145
  */
4168
- setVector2(value: Common.Vector2): void;
4146
+ static create_eventReceiverId_eventName(eventReceiverId: string, eventName: string): NetworkEventRegistration;
4147
+ static create(): NetworkEventRegistration;
4148
+ delete(): void;
4149
+ get eventReceiverId(): string;
4150
+ set eventReceiverId(value: string);
4151
+ get eventName(): string;
4152
+ set eventName(value: string);
4153
+ }
4154
+ }
4155
+ export declare namespace Multiplayer {
4156
+ /**
4157
+ @ingroup Multiplayer
4158
+ * @description Handles registration of interest, and dispatch of callbacks to interested parties, of events sent over the network to connected clients.
4159
+ * This object may be used to send arbitrary messages between clients, broadcasting messages to either all clients, or particular clients specified
4160
+ * by a clientID. Particular messages are generic and may be defined as any arbitrary string, and may carry payloads of csp::common::ReplicatedValue.
4161
+ */
4162
+ class NetworkEventBus extends NativeClassWrapper implements INativeResource {
4163
+ /** @internal */
4164
+ constructor(pointer: NativePointer);
4169
4165
  /**
4170
- * @description Get a csp::common::Vector2 value from this replicated value, will assert if not a csp::common::Vector2 type.
4171
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
4172
- * /// @return csp::common::Vector2
4166
+ * @description Sends a network event by EventName to all currently connected clients.
4167
+ * @param eventName - The identifying name for the event.
4168
+ * @param args - An array of arguments (csp::common::ReplicatedValue) to be passed as part of
4169
+ * the event payload.
4170
+ * @param callback - A callback with failure state.
4173
4171
  */
4174
- getVector2(): Common.Vector2;
4172
+ sendNetworkEvent(eventName: string, args: Common.Array<Common.ReplicatedValue>): Promise<Multiplayer.ErrorCode>;
4175
4173
  /**
4176
- * @description Set a Vector3 value for this replicated value from a csp::common::Vector3, will overwrite and previous value.
4174
+ * @description Sends a network event by EventName, to TargetClientId.
4175
+ * @param eventName - The identifying name for the event.
4176
+ * @param args - An array of arguments (csp::common::ReplicatedValue) to be passed as part of
4177
+ * the event payload.
4178
+ * @param targetClientId - The client ID to send the event to.
4179
+ * @param callback - A callback with failure state.
4177
4180
  */
4178
- setVector3(value: Common.Vector3): void;
4181
+ sendNetworkEventToClient(eventName: string, args: Common.Array<Common.ReplicatedValue>, targetClientId: bigint): Promise<Multiplayer.ErrorCode>;
4179
4182
  /**
4180
- * @description Get a csp::common::Vector3 value from this replicated value, will assert if not a csp::common::Vector3 type.
4181
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
4182
- * /// @return csp::common::Vector3
4183
+ * @description Register interest in a network event, such that the NetworkEventBus will call the provided callback when it arrives
4184
+ * @param registration - Registration information, containing a ReceiverID and an EventName. Will fail to register if
4185
+ * identical callback registration already registered.
4186
+ * @param callback - Callback to invoke when specified event is received. Will fail to register if null.
4183
4187
  */
4184
- getVector3(): Common.Vector3;
4188
+ listenNetworkEvent(registration: Multiplayer.NetworkEventRegistration, callback: (networkEventData: Common.NetworkEventData) => void): void;
4185
4189
  /**
4186
- * @description Set a Vector4 value for this replicated value from a csp::common::Vector4, will overwrite and previous value.
4190
+ * @description Deregister interest in a network event
4191
+ * @param registration - Registration information of already registered event, containing a ReceiverID and an EventName.
4187
4192
  */
4188
- setVector4(value: Common.Vector4): void;
4193
+ stopListenNetworkEvent(registration: Multiplayer.NetworkEventRegistration): void;
4189
4194
  /**
4190
- * @description Get a csp::common::Vector4 value from this replicated value, will assert if not a csp::common::Vector4 type.
4191
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
4192
- * /// @return csp::common::Vector4
4195
+ * @description Deregister interest in all network events registered to a particular EventReceiverId
4196
+ * @param eventReceiverId - EventReceiverId to deregister.
4193
4197
  */
4194
- getVector4(): Common.Vector4;
4198
+ stopListenAllNetworkEvents(eventReceiverId: string): void;
4195
4199
  /**
4196
- * @description Get a csp::common::Map value with a string value as the key.
4197
- * This will assert if not a csp::common::Map type with a string value as the key.
4198
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
4199
- * /// @return csp::common::Map
4200
+ * @description Get an array of all interests currently registered to the NetworkEventBus
4201
+ * @return Csp::common::array&lt;csp::multiplayer::networkeventregistration&gt; a container of all currently registered registrations.
4200
4202
  */
4201
- getStringMap(): Common.Map<string, Multiplayer.ReplicatedValue>;
4203
+ allRegistrations(): Common.Array<Multiplayer.NetworkEventRegistration>;
4202
4204
  /**
4203
- * @description Set a string Map value for this replicated value from a csp::common::Map, will overwrite any previous value.
4205
+ * @description Instructs the event bus to start listening to messages
4206
+ * @return True is successfully started listening, false if the connection is unavailable for some reason.
4204
4207
  */
4205
- setStringMap(value: Common.Map<string, Multiplayer.ReplicatedValue>): void;
4208
+ startEventMessageListening(): boolean;
4209
+ delete(): void;
4206
4210
  }
4207
4211
  }
4208
4212
  export declare namespace Multiplayer {
@@ -4940,8 +4944,86 @@ export declare namespace Multiplayer {
4940
4944
  }
4941
4945
  export declare namespace Systems {
4942
4946
  /**
4943
- * @description Base class for all Connected Spaces Platform Systems, which enforces passing of a WebClient or EventBus instance in the constructor of each
4944
- * System.
4947
+ * @description CSPSceneData which represents all data that exists for a space.
4948
+ @details This data structure is created through the deserialization of a CSPSceneDescription Json which is retrieved externally.
4949
+ * The json file used to create this structure is also used to create a systems::CSPSceneData object.
4950
+ * The reason these are seperated is to break dependencies between our multiplayer and corer modules.
4951
+ */
4952
+ class CSPSceneData extends NativeClassWrapper implements INativeResource {
4953
+ /** @internal */
4954
+ constructor(pointer: NativePointer);
4955
+ /**
4956
+ * @description Constructor for CSPSceneData by deserializing a SceneDescription json file.
4957
+ * @param sceneDescriptionJson - The SceneDescription to deserialize.
4958
+ */
4959
+ static create_sceneDescriptionJson(sceneDescriptionJson: string): CSPSceneData;
4960
+ delete(): void;
4961
+ get space(): Systems.Space;
4962
+ set space(value: Systems.Space);
4963
+ get assetCollections(): Common.Array<Systems.AssetCollection>;
4964
+ set assetCollections(value: Common.Array<Systems.AssetCollection>);
4965
+ get assets(): Common.Array<Systems.Asset>;
4966
+ set assets(value: Common.Array<Systems.Asset>);
4967
+ get sequences(): Common.Array<Systems.Sequence>;
4968
+ set sequences(value: Common.Array<Systems.Sequence>);
4969
+ }
4970
+ }
4971
+ export declare namespace Systems {
4972
+ /**
4973
+ @ingroup Status System
4974
+ * @description Stores the version and deprecation information for a service
4975
+ */
4976
+ class VersionMetadata extends NativeClassWrapper implements INativeResource {
4977
+ /** @internal */
4978
+ constructor(pointer: NativePointer);
4979
+ static create(): VersionMetadata;
4980
+ delete(): void;
4981
+ get version(): string;
4982
+ set version(value: string);
4983
+ get deprecationDatetime(): string;
4984
+ set deprecationDatetime(value: string);
4985
+ }
4986
+ }
4987
+ export declare namespace Systems {
4988
+ /**
4989
+ @ingroup Status System
4990
+ * @description Stores information about a service, including available versions
4991
+ */
4992
+ class ServiceStatus extends NativeClassWrapper implements INativeResource {
4993
+ /** @internal */
4994
+ constructor(pointer: NativePointer);
4995
+ static create(): ServiceStatus;
4996
+ delete(): void;
4997
+ get reverseProxy(): string;
4998
+ set reverseProxy(value: string);
4999
+ get name(): string;
5000
+ set name(value: string);
5001
+ get apiVersions(): Common.Array<Systems.VersionMetadata>;
5002
+ set apiVersions(value: Common.Array<Systems.VersionMetadata>);
5003
+ get currentApiVersion(): string;
5004
+ set currentApiVersion(value: string);
5005
+ }
5006
+ }
5007
+ export declare namespace Systems {
5008
+ /**
5009
+ @ingroup Status System
5010
+ * @description Store information about the current service deployment
5011
+ */
5012
+ class ServicesDeploymentStatus extends NativeClassWrapper implements INativeResource {
5013
+ /** @internal */
5014
+ constructor(pointer: NativePointer);
5015
+ static create(): ServicesDeploymentStatus;
5016
+ delete(): void;
5017
+ get version(): string;
5018
+ set version(value: string);
5019
+ get services(): Common.Array<Systems.ServiceStatus>;
5020
+ set services(value: Common.Array<Systems.ServiceStatus>);
5021
+ }
5022
+ }
5023
+ export declare namespace Systems {
5024
+ /**
5025
+ * @description Base class for all Connected Spaces Platform Systems, which enforces passing of a WebClient or NetworkEventBus instance in the constructor
5026
+ * of each System.
4945
5027
  */
4946
5028
  class SystemBase extends NativeClassWrapper {
4947
5029
  /** @internal */
@@ -4957,11 +5039,6 @@ export declare namespace Systems {
4957
5039
  * @description Deregisters the system from listening for the default event.
4958
5040
  */
4959
5041
  deregisterSystemCallback(): void;
4960
- /**
4961
- * @description Sets a callback for a default event.
4962
- * @param callback - Callback to receive data for the system that has been changed.
4963
- */
4964
- setSystemCallback(callback: (arg1: boolean, arg2: Common.Array<Multiplayer.ReplicatedValue>) => void): void;
4965
5042
  }
4966
5043
  }
4967
5044
  export declare namespace Systems {
@@ -5060,7 +5137,7 @@ export declare namespace Systems {
5060
5137
  getHotspotSequenceSystem(): Systems.HotspotSequenceSystem;
5061
5138
  getSpaceEntitySystem(): Multiplayer.SpaceEntitySystem;
5062
5139
  getMultiplayerConnection(): Multiplayer.MultiplayerConnection;
5063
- getEventBus(): Multiplayer.EventBus;
5140
+ getEventBus(): Multiplayer.NetworkEventBus;
5064
5141
  }
5065
5142
  }
5066
5143
  export declare namespace Systems {
@@ -6291,6 +6368,81 @@ export declare namespace Systems {
6291
6368
  isLocalUserMuted(): boolean;
6292
6369
  }
6293
6370
  }
6371
+ export declare namespace Common {
6372
+ /**
6373
+ * @description Describes the changes an asset has undergone when the client application is connected to a space.
6374
+ */
6375
+ class AssetDetailBlobChangedNetworkEventData extends Common.NetworkEventData implements INativeResource {
6376
+ /** @internal */
6377
+ constructor(pointer: NativePointer);
6378
+ static fromNetworkEventData(baseInstance: Common.NetworkEventData): Common.AssetDetailBlobChangedNetworkEventData;
6379
+ static create(): AssetDetailBlobChangedNetworkEventData;
6380
+ delete(): void;
6381
+ get changeType(): Common.EAssetChangeType;
6382
+ set changeType(value: Common.EAssetChangeType);
6383
+ get assetId(): string;
6384
+ set assetId(value: string);
6385
+ get version(): string;
6386
+ set version(value: string);
6387
+ get assetType(): Systems.EAssetType;
6388
+ set assetType(value: Systems.EAssetType);
6389
+ get assetCollectionId(): string;
6390
+ set assetCollectionId(value: string);
6391
+ }
6392
+ }
6393
+ export declare namespace Common {
6394
+ /**
6395
+ * @description Class used to provide details of a conversation message that has been received whilst the client application is connected to a space.
6396
+ */
6397
+ class ConversationNetworkEventData extends Common.NetworkEventData implements INativeResource {
6398
+ /** @internal */
6399
+ constructor(pointer: NativePointer);
6400
+ static fromNetworkEventData(baseInstance: Common.NetworkEventData): Common.ConversationNetworkEventData;
6401
+ static create(): ConversationNetworkEventData;
6402
+ delete(): void;
6403
+ get messageType(): Multiplayer.ConversationEventType;
6404
+ set messageType(value: Multiplayer.ConversationEventType);
6405
+ get messageInfo(): Multiplayer.MessageInfo;
6406
+ set messageInfo(value: Multiplayer.MessageInfo);
6407
+ }
6408
+ }
6409
+ export declare namespace Common {
6410
+ /**
6411
+ * @description Class used to provide details of a permission change that has happened to a user whilst the client application is connected to a space.
6412
+ */
6413
+ class AccessControlChangedNetworkEventData extends Common.NetworkEventData implements INativeResource {
6414
+ /** @internal */
6415
+ constructor(pointer: NativePointer);
6416
+ static fromNetworkEventData(baseInstance: Common.NetworkEventData): Common.AccessControlChangedNetworkEventData;
6417
+ static create(): AccessControlChangedNetworkEventData;
6418
+ delete(): void;
6419
+ get spaceId(): string;
6420
+ set spaceId(value: string);
6421
+ get userRoles(): Common.Array<Systems.SpaceUserRole>;
6422
+ set userRoles(value: Common.Array<Systems.SpaceUserRole>);
6423
+ get changeType(): Common.EPermissionChangeType;
6424
+ set changeType(value: Common.EPermissionChangeType);
6425
+ get userId(): string;
6426
+ set userId(value: string);
6427
+ }
6428
+ }
6429
+ export declare namespace Common {
6430
+ class SequenceChangedNetworkEventData extends Common.NetworkEventData implements INativeResource {
6431
+ /** @internal */
6432
+ constructor(pointer: NativePointer);
6433
+ static fromNetworkEventData(baseInstance: Common.NetworkEventData): Common.SequenceChangedNetworkEventData;
6434
+ static create(): SequenceChangedNetworkEventData;
6435
+ delete(): void;
6436
+ get updateType(): Common.ESequenceUpdateType;
6437
+ set updateType(value: Common.ESequenceUpdateType);
6438
+ get key(): string;
6439
+ set key(value: string);
6440
+ get newKey(): string;
6441
+ set newKey(value: string);
6442
+ get hotspotData(): Common.HotspotSequenceChangedNetworkEventData;
6443
+ set hotspotData(value: Common.HotspotSequenceChangedNetworkEventData);
6444
+ }
6445
+ }
6294
6446
  export declare namespace Multiplayer {
6295
6447
  /**
6296
6448
  @ingroup AnimatedModelSpaceComponent
@@ -7441,7 +7593,7 @@ export declare namespace Multiplayer {
7441
7593
  * @description Sets a callback for when the conversation is updated by another client.
7442
7594
  * @param callback - Callback to receive data for the conversation that has been changed.
7443
7595
  */
7444
- setConversationUpdateCallback(callback: (arg1: Multiplayer.ConversationEventParams) => void): void;
7596
+ setConversationUpdateCallback(callback: (arg1: Common.ConversationNetworkEventData) => void): void;
7445
7597
  /**
7446
7598
  * \addtogroup IPositionComponent
7447
7599
  @{
@@ -7548,13 +7700,13 @@ export declare namespace Multiplayer {
7548
7700
  * @param key - The ID of the property of which the value will be retrieved.
7549
7701
  * @return The value of the property identified by the provided Key.
7550
7702
  */
7551
- getCustomProperty(key: string): Multiplayer.ReplicatedValue;
7703
+ getCustomProperty(key: string): Common.ReplicatedValue;
7552
7704
  /**
7553
7705
  * @description Sets a custom property by specifying a unique Key and its relative property Value.
7554
7706
  * @param key - Uniquely identifies this new property.
7555
7707
  * @param value - The value to store for this new property.
7556
7708
  */
7557
- setCustomProperty(key: string, value: Multiplayer.ReplicatedValue): void;
7709
+ setCustomProperty(key: string, value: Common.ReplicatedValue): void;
7558
7710
  /**
7559
7711
  * @description Removes the specified property by Key.
7560
7712
  * @param key - The ID of the property that will be removed.
@@ -9395,6 +9547,23 @@ export declare namespace Multiplayer {
9395
9547
  delete(): void;
9396
9548
  }
9397
9549
  }
9550
+ export declare namespace Systems {
9551
+ /**
9552
+ @ingroup Status System
9553
+ * @description Data class used to contain information when a Response is received from the Status Server
9554
+ */
9555
+ class ServicesDeploymentStatusResult extends Systems.ResultBase implements INativeResource {
9556
+ /** @internal */
9557
+ constructor(pointer: NativePointer);
9558
+ static fromResultBase(baseInstance: Systems.ResultBase): Systems.ServicesDeploymentStatusResult;
9559
+ /**
9560
+ * @description Will return services deployment status for the latest available deployment from the server
9561
+ * @return The latest services deployment status
9562
+ */
9563
+ getLatestServicesDeploymentStatus(): Systems.ServicesDeploymentStatus;
9564
+ delete(): void;
9565
+ }
9566
+ }
9398
9567
  export declare namespace Systems {
9399
9568
  /**
9400
9569
  * @description A result handler that is used to notify a user of an error.
@@ -9978,12 +10147,12 @@ export declare namespace Systems {
9978
10147
  * @description Sets a callback for an asset changed event. Triggered when assets, such as textures or meshes, are modified
9979
10148
  * @param callback - Callback to receive data for the asset that has been changed.
9980
10149
  */
9981
- setAssetDetailBlobChangedCallback(callback: (arg1: Multiplayer.AssetDetailBlobParams) => void): void;
10150
+ setAssetDetailBlobChangedCallback(callback: (arg1: Common.AssetDetailBlobChangedNetworkEventData) => void): void;
9982
10151
  /**
9983
10152
  * @description Sets a callback for a material changed event.
9984
10153
  * @param callback - Callback to receive data for the material that has been changed.
9985
10154
  */
9986
- setMaterialChangedCallback(callback: (arg1: Multiplayer.MaterialChangedParams) => void): void;
10155
+ setMaterialChangedCallback(callback: (arg1: Common.MaterialChangedParams) => void): void;
9987
10156
  /**
9988
10157
  * @description Registers the system to listen for the named event.
9989
10158
  */
@@ -10636,7 +10805,7 @@ export declare namespace Systems {
10636
10805
  /** @internal */
10637
10806
  constructor(pointer: NativePointer);
10638
10807
  static fromSystemBase(baseInstance: Systems.SystemBase): Systems.HotspotSequenceSystem;
10639
- static create_sequenceSystem_spaceSystem_eventBus_logSystem(sequenceSystem: Systems.SequenceSystem, spaceSystem: Systems.SpaceSystem, eventBus: Multiplayer.EventBus, logSystem: Common.LogSystem): HotspotSequenceSystem;
10808
+ static create_sequenceSystem_spaceSystem_eventBus_logSystem(sequenceSystem: Systems.SequenceSystem, spaceSystem: Systems.SpaceSystem, eventBus: Multiplayer.NetworkEventBus, logSystem: Common.LogSystem): HotspotSequenceSystem;
10640
10809
  /**
10641
10810
  * @description Create a Hotspot group
10642
10811
  * @param groupName - The unique grouping name
@@ -10688,7 +10857,7 @@ export declare namespace Systems {
10688
10857
  * @description Sets a callback to be fired when a hotspot sequence is changed.
10689
10858
  * @param callback - Callback to receive data for the hotspot sequence that has been changed.
10690
10859
  */
10691
- setHotspotSequenceChangedCallback(callback: (arg1: Multiplayer.SequenceHotspotChangedParams) => void): void;
10860
+ setHotspotSequenceChangedCallback(callback: (arg1: Common.SequenceChangedNetworkEventData) => void): void;
10692
10861
  /**
10693
10862
  * @description Registers the system to listen for the named event.
10694
10863
  */
@@ -11030,7 +11199,7 @@ export declare namespace Systems {
11030
11199
  * @description Sets a callback for a sequence changed event.
11031
11200
  * @param callback - Callback to receive data for the sequence that has been changed.
11032
11201
  */
11033
- setSequenceChangedCallback(callback: (arg1: Multiplayer.SequenceChangedParams) => void): void;
11202
+ setSequenceChangedCallback(callback: (arg1: Common.SequenceChangedNetworkEventData) => void): void;
11034
11203
  /**
11035
11204
  * @description Registers the system to listen for the named event.
11036
11205
  */
@@ -12213,7 +12382,7 @@ export declare namespace Systems {
12213
12382
  * Clients can use this event to reflect access levels in real time.
12214
12383
  * /// @param Callback UserPermissionsChangedCallbackHandler: Callback to receive data for the user permissions that has been changed.
12215
12384
  */
12216
- setUserPermissionsChangedCallback(callback: (arg1: Multiplayer.UserPermissionsParams) => void): void;
12385
+ setUserPermissionsChangedCallback(callback: (arg1: Common.AccessControlChangedNetworkEventData) => void): void;
12217
12386
  /**
12218
12387
  * @description Registers the system to listen for the named event.
12219
12388
  */
@@ -12230,14 +12399,19 @@ export declare namespace Common {
12230
12399
  constructor(pointer: NativePointer, TTypeFactory: ProxyClassFactory, TTypeName: string);
12231
12400
  private TTypeFactory;
12232
12401
  private TTypeName;
12233
- static ofcsp_multiplayer_ReplicatedValue(): Array<Multiplayer.ReplicatedValue>;
12234
12402
  static ofcsp_multiplayer_ComponentUpdateInfo(): Array<Multiplayer.ComponentUpdateInfo>;
12403
+ static ofcsp_common_ReplicatedValue(): Array<Common.ReplicatedValue>;
12235
12404
  static ofcsp_systems_SpaceUserRole(): Array<Systems.SpaceUserRole>;
12405
+ static ofcsp_multiplayer_SpaceEntity(): Array<Multiplayer.SpaceEntity>;
12406
+ static ofcsp_multiplayer_NetworkEventRegistration(): Array<Multiplayer.NetworkEventRegistration>;
12236
12407
  static ofcsp_multiplayer_MessageInfo(): Array<Multiplayer.MessageInfo>;
12408
+ static ofcsp_systems_AssetCollection(): Array<Systems.AssetCollection>;
12409
+ static ofcsp_systems_Asset(): Array<Systems.Asset>;
12410
+ static ofcsp_systems_Sequence(): Array<Systems.Sequence>;
12411
+ static ofcsp_systems_VersionMetadata(): Array<Systems.VersionMetadata>;
12412
+ static ofcsp_systems_ServiceStatus(): Array<Systems.ServiceStatus>;
12237
12413
  static ofString(): Array<string>;
12238
12414
  static ofcsp_systems_EAssetPlatform(): Array<Systems.EAssetPlatform>;
12239
- static ofcsp_systems_Asset(): Array<Systems.Asset>;
12240
- static ofcsp_systems_AssetCollection(): Array<Systems.AssetCollection>;
12241
12415
  static ofcsp_systems_EAssetCollectionType(): Array<Systems.EAssetCollectionType>;
12242
12416
  static ofcsp_systems_EAssetType(): Array<Systems.EAssetType>;
12243
12417
  static ofcsp_systems_LODAsset(): Array<Systems.LODAsset>;
@@ -12254,7 +12428,6 @@ export declare namespace Common {
12254
12428
  static ofcsp_systems_FeatureLimitInfo(): Array<Systems.FeatureLimitInfo>;
12255
12429
  static ofcsp_systems_FeatureQuotaInfo(): Array<Systems.FeatureQuotaInfo>;
12256
12430
  static ofcsp_systems_TierFeatures(): Array<Systems.TierFeatures>;
12257
- static ofcsp_systems_Sequence(): Array<Systems.Sequence>;
12258
12431
  static ofcsp_systems_Site(): Array<Systems.Site>;
12259
12432
  static ofcsp_systems_GeoLocation(): Array<Systems.GeoLocation>;
12260
12433
  static ofcsp_systems_Space(): Array<Systems.Space>;
@@ -12271,14 +12444,19 @@ export declare namespace Common {
12271
12444
  static ofcsp_multiplayer_ComponentBase(): Array<Multiplayer.ComponentBase>;
12272
12445
  static ofcsp_common_Map_String_String(): Array<Common.Map<string, string>>;
12273
12446
  static ofcsp_common_Array_String(): Array<Common.Array<string>>;
12274
- static ofcsp_multiplayer_ReplicatedValue_number(size: number): Array<Multiplayer.ReplicatedValue>;
12275
12447
  static ofcsp_multiplayer_ComponentUpdateInfo_number(size: number): Array<Multiplayer.ComponentUpdateInfo>;
12448
+ static ofcsp_common_ReplicatedValue_number(size: number): Array<Common.ReplicatedValue>;
12276
12449
  static ofcsp_systems_SpaceUserRole_number(size: number): Array<Systems.SpaceUserRole>;
12450
+ static ofcsp_multiplayer_SpaceEntity_number(size: number): Array<Multiplayer.SpaceEntity>;
12451
+ static ofcsp_multiplayer_NetworkEventRegistration_number(size: number): Array<Multiplayer.NetworkEventRegistration>;
12277
12452
  static ofcsp_multiplayer_MessageInfo_number(size: number): Array<Multiplayer.MessageInfo>;
12453
+ static ofcsp_systems_AssetCollection_number(size: number): Array<Systems.AssetCollection>;
12454
+ static ofcsp_systems_Asset_number(size: number): Array<Systems.Asset>;
12455
+ static ofcsp_systems_Sequence_number(size: number): Array<Systems.Sequence>;
12456
+ static ofcsp_systems_VersionMetadata_number(size: number): Array<Systems.VersionMetadata>;
12457
+ static ofcsp_systems_ServiceStatus_number(size: number): Array<Systems.ServiceStatus>;
12278
12458
  static ofString_number(size: number): Array<string>;
12279
12459
  static ofcsp_systems_EAssetPlatform_number(size: number): Array<Systems.EAssetPlatform>;
12280
- static ofcsp_systems_Asset_number(size: number): Array<Systems.Asset>;
12281
- static ofcsp_systems_AssetCollection_number(size: number): Array<Systems.AssetCollection>;
12282
12460
  static ofcsp_systems_EAssetCollectionType_number(size: number): Array<Systems.EAssetCollectionType>;
12283
12461
  static ofcsp_systems_EAssetType_number(size: number): Array<Systems.EAssetType>;
12284
12462
  static ofcsp_systems_LODAsset_number(size: number): Array<Systems.LODAsset>;
@@ -12295,7 +12473,6 @@ export declare namespace Common {
12295
12473
  static ofcsp_systems_FeatureLimitInfo_number(size: number): Array<Systems.FeatureLimitInfo>;
12296
12474
  static ofcsp_systems_FeatureQuotaInfo_number(size: number): Array<Systems.FeatureQuotaInfo>;
12297
12475
  static ofcsp_systems_TierFeatures_number(size: number): Array<Systems.TierFeatures>;
12298
- static ofcsp_systems_Sequence_number(size: number): Array<Systems.Sequence>;
12299
12476
  static ofcsp_systems_Site_number(size: number): Array<Systems.Site>;
12300
12477
  static ofcsp_systems_GeoLocation_number(size: number): Array<Systems.GeoLocation>;
12301
12478
  static ofcsp_systems_Space_number(size: number): Array<Systems.Space>;
@@ -12354,15 +12531,15 @@ export declare namespace Common {
12354
12531
  private TKeyTypeName;
12355
12532
  private TValueTypeFactory;
12356
12533
  private TValueTypeName;
12357
- static ofUInt32Andcsp_multiplayer_ReplicatedValue(): Map<number, Multiplayer.ReplicatedValue>;
12358
- static ofStringAndcsp_multiplayer_ReplicatedValue(): Map<string, Multiplayer.ReplicatedValue>;
12534
+ static ofStringAndcsp_common_ReplicatedValue(): Map<string, Common.ReplicatedValue>;
12535
+ static ofUInt32Andcsp_common_ReplicatedValue(): Map<number, Common.ReplicatedValue>;
12359
12536
  static ofUInt16Andcsp_multiplayer_ComponentBase(): Map<number, Multiplayer.ComponentBase>;
12360
12537
  static ofStringAndString(): Map<string, string>;
12361
12538
  static ofStringAndcsp_systems_Asset(): Map<string, Systems.Asset>;
12362
12539
  static ofStringAndcsp_common_Map_String_String(): Map<string, Common.Map<string, string>>;
12363
12540
  static ofStringAndcsp_common_Array_String(): Map<string, Common.Array<string>>;
12364
- static ofUInt32Andcsp_multiplayer_ReplicatedValue_Map(other: Common.Map<number, Multiplayer.ReplicatedValue>): Map<number, Multiplayer.ReplicatedValue>;
12365
- static ofStringAndcsp_multiplayer_ReplicatedValue_Map(other: Common.Map<string, Multiplayer.ReplicatedValue>): Map<string, Multiplayer.ReplicatedValue>;
12541
+ static ofStringAndcsp_common_ReplicatedValue_Map(other: Common.Map<string, Common.ReplicatedValue>): Map<string, Common.ReplicatedValue>;
12542
+ static ofUInt32Andcsp_common_ReplicatedValue_Map(other: Common.Map<number, Common.ReplicatedValue>): Map<number, Common.ReplicatedValue>;
12366
12543
  static ofUInt16Andcsp_multiplayer_ComponentBase_Map(other: Common.Map<number, Multiplayer.ComponentBase>): Map<number, Multiplayer.ComponentBase>;
12367
12544
  static ofStringAndString_Map(other: Common.Map<string, string>): Map<string, string>;
12368
12545
  static ofStringAndcsp_systems_Asset_Map(other: Common.Map<string, Systems.Asset>): Map<string, Systems.Asset>;