connected-spaces-platform.web 6.5.0 → 6.7.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.
@@ -1804,6 +1804,10 @@ export declare namespace Common {
1804
1804
  set userId(value: string);
1805
1805
  get deviceId(): string;
1806
1806
  set deviceId(value: string);
1807
+ get defaultApplicationSettings(): Common.List<Common.ApplicationSettings>;
1808
+ set defaultApplicationSettings(value: Common.List<Common.ApplicationSettings>);
1809
+ get defaultSettings(): Common.List<Common.SettingsCollection>;
1810
+ set defaultSettings(value: Common.List<Common.SettingsCollection>);
1807
1811
  }
1808
1812
  }
1809
1813
  export declare namespace Common {
@@ -3414,7 +3418,7 @@ export declare namespace Common {
3414
3418
  constructor(pointer: NativePointer);
3415
3419
  /**
3416
3420
  * @description A default ReplicatedValue will not have a valid type ("ReplicatedValueType::InvalidType"), and will have no internal value associated.
3417
- * /// Do not use this constructor unless you know what you are doing!
3421
+ * This constuctor will create the value in an invalid state. Do not use unless you know what you are doing!
3418
3422
  */
3419
3423
  static create(): ReplicatedValue;
3420
3424
  /**
@@ -3454,38 +3458,13 @@ export declare namespace Common {
3454
3458
  static create_vector4Value(vector4Value: Common.Vector4): ReplicatedValue;
3455
3459
  /**
3456
3460
  * @description Construct a ReplicatedValue based on an csp::common::Map type with a string value as the key.
3457
- * @param inMapValue - Initial value.
3461
+ * @param inValue - Initial value.
3458
3462
  */
3459
- static create_mapValue(mapValue: Common.Map<string, Common.ReplicatedValue>): ReplicatedValue;
3460
- /**
3461
- * @description Copy constructor
3462
- * @param other - The value to copy.
3463
- */
3464
- static create_other(other: Common.ReplicatedValue): ReplicatedValue;
3463
+ static create_value(value: Common.Map<string, Common.ReplicatedValue>): ReplicatedValue;
3465
3464
  /**
3466
3465
  * @description Destroys the replicated value instance.
3467
3466
  */
3468
3467
  delete(): void;
3469
- /**
3470
- * @description Assignment operator overload.
3471
- * @param inValue - Other replicated value to set this one to.
3472
- */
3473
- /**
3474
- * @description Equality operator overload.
3475
- * @param replicatedValue - Other value to compare to.
3476
- */
3477
- /**
3478
- * @description Non equality operator overload.
3479
- * @param replicatedValue - Other value to compare to.
3480
- */
3481
- /**
3482
- * @description Less than operator overload.
3483
- * @param replicatedValue - Other value to compare to.
3484
- */
3485
- /**
3486
- * @description Greater than operator overload.
3487
- * @param replicatedValue - Other value to compare to.
3488
- */
3489
3468
  /**
3490
3469
  * @description Gets the type of replicated value.
3491
3470
  * @return Enum representing all supported replication base types.
@@ -3498,8 +3477,7 @@ export declare namespace Common {
3498
3477
  setBool(value: boolean): void;
3499
3478
  /**
3500
3479
  * @description Get a bool value from this replicated value, will assert if not a bool type.
3501
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3502
- * /// @return bool
3480
+ * @return Bool
3503
3481
  */
3504
3482
  getBool(): boolean;
3505
3483
  /**
@@ -3509,8 +3487,7 @@ export declare namespace Common {
3509
3487
  setFloat(value: number): void;
3510
3488
  /**
3511
3489
  * @description Get a float value from this replicated value, will assert if not a float type.
3512
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3513
- * /// @return float value
3490
+ * @return Float value
3514
3491
  */
3515
3492
  getFloat(): number;
3516
3493
  /**
@@ -3520,15 +3497,13 @@ export declare namespace Common {
3520
3497
  setInt(value: bigint): void;
3521
3498
  /**
3522
3499
  * @description Get a int64 value from this replicated value, will assert if not a int64 type.
3523
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3524
- * /// @return int64 value
3500
+ * @return Int64 value
3525
3501
  */
3526
3502
  getInt(): bigint;
3527
3503
  setString(value: string): void;
3528
3504
  /**
3529
3505
  * @description Get a csp::common::String& value from this replicated value, will assert if not a csp::common::String type.
3530
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3531
- * /// @return csp::common::String&
3506
+ * @return Csp::common::string&
3532
3507
  */
3533
3508
  getString(): string;
3534
3509
  /**
@@ -3537,8 +3512,7 @@ export declare namespace Common {
3537
3512
  setVector2(value: Common.Vector2): void;
3538
3513
  /**
3539
3514
  * @description Get a csp::common::Vector2 value from this replicated value, will assert if not a csp::common::Vector2 type.
3540
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3541
- * /// @return csp::common::Vector2
3515
+ * @return Csp::common::vector2
3542
3516
  */
3543
3517
  getVector2(): Common.Vector2;
3544
3518
  /**
@@ -3547,8 +3521,7 @@ export declare namespace Common {
3547
3521
  setVector3(value: Common.Vector3): void;
3548
3522
  /**
3549
3523
  * @description Get a csp::common::Vector3 value from this replicated value, will assert if not a csp::common::Vector3 type.
3550
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3551
- * /// @return csp::common::Vector3
3524
+ * @return Csp::common::vector3
3552
3525
  */
3553
3526
  getVector3(): Common.Vector3;
3554
3527
  /**
@@ -3557,15 +3530,13 @@ export declare namespace Common {
3557
3530
  setVector4(value: Common.Vector4): void;
3558
3531
  /**
3559
3532
  * @description Get a csp::common::Vector4 value from this replicated value, will assert if not a csp::common::Vector4 type.
3560
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3561
- * /// @return csp::common::Vector4
3533
+ * @return Csp::common::vector4
3562
3534
  */
3563
3535
  getVector4(): Common.Vector4;
3564
3536
  /**
3565
3537
  * @description Get a csp::common::Map value with a string value as the key.
3566
3538
  * This will assert if not a csp::common::Map type with a string value as the key.
3567
- * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
3568
- * /// @return csp::common::Map
3539
+ * @return Csp::common::map
3569
3540
  */
3570
3541
  getStringMap(): Common.Map<string, Common.ReplicatedValue>;
3571
3542
  /**
@@ -3574,6 +3545,43 @@ export declare namespace Common {
3574
3545
  setStringMap(value: Common.Map<string, Common.ReplicatedValue>): void;
3575
3546
  }
3576
3547
  }
3548
+ export declare namespace Common {
3549
+ /**
3550
+ @ingroup Application Settings System
3551
+ * @description Represents configuration settings for an application context.
3552
+ */
3553
+ class ApplicationSettings extends NativeClassWrapper implements INativeResource {
3554
+ /** @internal */
3555
+ constructor(pointer: NativePointer);
3556
+ static create(): ApplicationSettings;
3557
+ delete(): void;
3558
+ get applicationName(): string;
3559
+ set applicationName(value: string);
3560
+ get context(): string;
3561
+ set context(value: string);
3562
+ get allowAnonymous(): boolean;
3563
+ set allowAnonymous(value: boolean);
3564
+ get settings(): Common.Map<string, string>;
3565
+ set settings(value: Common.Map<string, string>);
3566
+ }
3567
+ }
3568
+ export declare namespace Common {
3569
+ /**
3570
+ * @description Represents configuration settings related to a user in a specific context
3571
+ */
3572
+ class SettingsCollection extends NativeClassWrapper implements INativeResource {
3573
+ /** @internal */
3574
+ constructor(pointer: NativePointer);
3575
+ static create(): SettingsCollection;
3576
+ delete(): void;
3577
+ get userId(): string;
3578
+ set userId(value: string);
3579
+ get context(): string;
3580
+ set context(value: string);
3581
+ get settings(): Common.Map<string, string>;
3582
+ set settings(value: Common.Map<string, string>);
3583
+ }
3584
+ }
3577
3585
  export declare namespace Common {
3578
3586
  /**
3579
3587
  * @description Variant is an intermediate class that enables clients to pack data into types that are supported by Connected Spaces Platform replication
@@ -5779,44 +5787,6 @@ export declare namespace Systems {
5779
5787
  set metaData(value: Common.Map<string, string>);
5780
5788
  }
5781
5789
  }
5782
- export declare namespace Systems {
5783
- /**
5784
- @ingroup Application Settings System
5785
- * @description Represents configuration settings for an application context.
5786
- */
5787
- class ApplicationSettings extends NativeClassWrapper implements INativeResource {
5788
- /** @internal */
5789
- constructor(pointer: NativePointer);
5790
- static create(): ApplicationSettings;
5791
- delete(): void;
5792
- get applicationName(): string;
5793
- set applicationName(value: string);
5794
- get context(): string;
5795
- set context(value: string);
5796
- get allowAnonymous(): boolean;
5797
- set allowAnonymous(value: boolean);
5798
- get settings(): Common.Map<string, string>;
5799
- set settings(value: Common.Map<string, string>);
5800
- }
5801
- }
5802
- export declare namespace Systems {
5803
- /**
5804
- @ingroup Settings System
5805
- * @description Data representation of a Settings collection which maps to a UserService::Settings.
5806
- */
5807
- class SettingsCollection extends NativeClassWrapper implements INativeResource {
5808
- /** @internal */
5809
- constructor(pointer: NativePointer);
5810
- static create(): SettingsCollection;
5811
- delete(): void;
5812
- get userId(): string;
5813
- set userId(value: string);
5814
- get context(): string;
5815
- set context(value: string);
5816
- get settings(): Common.Map<string, string>;
5817
- set settings(value: Common.Map<string, string>);
5818
- }
5819
- }
5820
5790
  export declare namespace Systems {
5821
5791
  /**
5822
5792
  @ingroup Space System
@@ -11712,7 +11682,7 @@ export declare namespace Systems {
11712
11682
  /** @internal */
11713
11683
  constructor(pointer: NativePointer);
11714
11684
  static fromResultBase(baseInstance: Systems.ResultBase): Systems.ApplicationSettingsResult;
11715
- getApplicationSettings(): Systems.ApplicationSettings;
11685
+ getApplicationSettings(): Common.ApplicationSettings;
11716
11686
  delete(): void;
11717
11687
  }
11718
11688
  }
@@ -11759,7 +11729,7 @@ export declare namespace Systems {
11759
11729
  * @description Retrieves the settings collection result.
11760
11730
  * @return Const ref of settings collection class
11761
11731
  */
11762
- getSettingsCollection(): Systems.SettingsCollection;
11732
+ getSettingsCollection(): Common.SettingsCollection;
11763
11733
  delete(): void;
11764
11734
  }
11765
11735
  }
@@ -13085,12 +13055,18 @@ export declare namespace Common {
13085
13055
  constructor(pointer: NativePointer, TTypeFactory: ProxyClassFactory, TTypeName: string);
13086
13056
  private TTypeFactory;
13087
13057
  private TTypeName;
13058
+ static ofcsp_common_ApplicationSettings(): List<Common.ApplicationSettings>;
13059
+ static ofcsp_common_SettingsCollection(): List<Common.SettingsCollection>;
13088
13060
  static ofcsp_multiplayer_SpaceEntity(): List<Multiplayer.SpaceEntity>;
13089
13061
  static ofString(): List<string>;
13090
13062
  static ofcsp_common_Vector3(): List<Common.Vector3>;
13063
+ static ofcsp_common_ApplicationSettings_number(minimumSize: number): List<Common.ApplicationSettings>;
13064
+ static ofcsp_common_SettingsCollection_number(minimumSize: number): List<Common.SettingsCollection>;
13091
13065
  static ofcsp_multiplayer_SpaceEntity_number(minimumSize: number): List<Multiplayer.SpaceEntity>;
13092
13066
  static ofString_number(minimumSize: number): List<string>;
13093
13067
  static ofcsp_common_Vector3_number(minimumSize: number): List<Common.Vector3>;
13068
+ static ofcsp_common_ApplicationSettings_List(other: Common.List<Common.ApplicationSettings>): List<Common.ApplicationSettings>;
13069
+ static ofcsp_common_SettingsCollection_List(other: Common.List<Common.SettingsCollection>): List<Common.SettingsCollection>;
13094
13070
  static ofcsp_multiplayer_SpaceEntity_List(other: Common.List<Multiplayer.SpaceEntity>): List<Multiplayer.SpaceEntity>;
13095
13071
  static ofString_List(other: Common.List<string>): List<string>;
13096
13072
  static ofcsp_common_Vector3_List(other: Common.List<Common.Vector3>): List<Common.Vector3>;
@@ -13115,16 +13091,16 @@ export declare namespace Common {
13115
13091
  private TValueTypeFactory;
13116
13092
  private TValueTypeName;
13117
13093
  static ofStringAndcsp_common_ReplicatedValue(): Map<string, Common.ReplicatedValue>;
13094
+ static ofStringAndString(): Map<string, string>;
13118
13095
  static ofUInt32Andcsp_common_ReplicatedValue(): Map<number, Common.ReplicatedValue>;
13119
13096
  static ofUInt16Andcsp_multiplayer_ComponentBase(): Map<number, Multiplayer.ComponentBase>;
13120
- static ofStringAndString(): Map<string, string>;
13121
13097
  static ofStringAndcsp_systems_Asset(): Map<string, Systems.Asset>;
13122
13098
  static ofStringAndcsp_common_Map_String_String(): Map<string, Common.Map<string, string>>;
13123
13099
  static ofStringAndcsp_common_Array_String(): Map<string, Common.Array<string>>;
13124
13100
  static ofStringAndcsp_common_ReplicatedValue_Map(other: Common.Map<string, Common.ReplicatedValue>): Map<string, Common.ReplicatedValue>;
13101
+ static ofStringAndString_Map(other: Common.Map<string, string>): Map<string, string>;
13125
13102
  static ofUInt32Andcsp_common_ReplicatedValue_Map(other: Common.Map<number, Common.ReplicatedValue>): Map<number, Common.ReplicatedValue>;
13126
13103
  static ofUInt16Andcsp_multiplayer_ComponentBase_Map(other: Common.Map<number, Multiplayer.ComponentBase>): Map<number, Multiplayer.ComponentBase>;
13127
- static ofStringAndString_Map(other: Common.Map<string, string>): Map<string, string>;
13128
13104
  static ofStringAndcsp_systems_Asset_Map(other: Common.Map<string, Systems.Asset>): Map<string, Systems.Asset>;
13129
13105
  static ofStringAndcsp_common_Map_String_String_Map(other: Common.Map<string, Common.Map<string, string>>): Map<string, Common.Map<string, string>>;
13130
13106
  static ofStringAndcsp_common_Array_String_Map(other: Common.Map<string, Common.Array<string>>): Map<string, Common.Array<string>>;