@rbxts/types 1.0.922 → 1.0.924

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.
@@ -83,6 +83,7 @@ interface Services {
83
83
  FacialAnimationStreamingServiceV2: FacialAnimationStreamingServiceV2;
84
84
  FeatureRestrictionManager: FeatureRestrictionManager;
85
85
  FileManagerService: FileManagerService;
86
+ FileSyncReplicationService: FileSyncReplicationService;
86
87
  GamepadService: GamepadService;
87
88
  GamePassService: GamePassService;
88
89
  GameSettings: GameSettings;
@@ -95,6 +96,7 @@ interface Services {
95
96
  HapticService: HapticService;
96
97
  HarmonyService: HarmonyService;
97
98
  HeapProfilerService: HeapProfilerService;
99
+ HeatmapQueryService: HeatmapQueryService;
98
100
  HeatmapService: HeatmapService;
99
101
  HeightmapImporterService: HeightmapImporterService;
100
102
  HttpService: HttpService;
@@ -2299,7 +2301,7 @@ interface AvatarSettings extends Instance {
2299
2301
  readonly _nominal_AvatarSettings: unique symbol;
2300
2302
  }
2301
2303
  /**
2302
- * A container object that holds a player's inventory. Any `Tool` in a player's Backpack will be displayed in their inventory at the bottom of their screen.
2304
+ * A container object that holds a player's inventory. Any `Tool` in a player's `Backpack` will be displayed in their inventory at the bottom of the screen.
2303
2305
  *
2304
2306
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Backpack)
2305
2307
  */
@@ -2545,7 +2547,7 @@ interface CoreGui extends BasePlayerGui {
2545
2547
  readonly _nominal_CoreGui: unique symbol;
2546
2548
  }
2547
2549
  /**
2548
- * A container for a player's currently rendered `ScreenGuis`.
2550
+ * A container that holds a player's UI.
2549
2551
  *
2550
2552
  * - **Tags**: NotCreatable, PlayerReplicated
2551
2553
  *
@@ -3563,7 +3565,7 @@ interface ConfigService extends Instance {
3563
3565
  readonly _nominal_ConfigService: unique symbol;
3564
3566
  }
3565
3567
  /**
3566
- * The Configuration object is a container object that is designed to hold value objects to make values used in `Tools` or any model using `Scripts` more accessible.
3568
+ * A container object designed to hold value objects. Makes values used in `Tools` or any model using `Scripts` more accessible.
3567
3569
  *
3568
3570
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Configuration)
3569
3571
  */
@@ -5022,7 +5024,7 @@ interface ExperienceStateCaptureService extends Instance {
5022
5024
  readonly _nominal_ExperienceStateCaptureService: unique symbol;
5023
5025
  }
5024
5026
  /**
5025
- * - **Tags**: NotCreatable, Service, NotReplicated
5027
+ * - **Tags**: NotCreatable, Service
5026
5028
  *
5027
5029
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExperienceStateRecordingService)
5028
5030
  */
@@ -5868,6 +5870,21 @@ interface FileManagerService extends Instance {
5868
5870
  */
5869
5871
  readonly _nominal_FileManagerService: unique symbol;
5870
5872
  }
5873
+ /**
5874
+ * - **Tags**: NotCreatable, Service
5875
+ *
5876
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FileSyncReplicationService)
5877
+ */
5878
+ interface FileSyncReplicationService extends Instance {
5879
+ /**
5880
+ * **DO NOT USE!**
5881
+ *
5882
+ * This field exists to force TypeScript to recognize this as a nominal type
5883
+ * @hidden
5884
+ * @deprecated
5885
+ */
5886
+ readonly _nominal_FileSyncReplicationService: unique symbol;
5887
+ }
5871
5888
  /**
5872
5889
  * A preconfigured particle emitter with the visual aesthetic of fire.
5873
5890
  *
@@ -7137,6 +7154,21 @@ interface HeapProfilerService extends Instance {
7137
7154
  */
7138
7155
  readonly OnNewData: RBXScriptSignal<(player: Player, jsonString: buffer, id: number, compressedLength: number, uncompressedLength: number) => void>;
7139
7156
  }
7157
+ /**
7158
+ * - **Tags**: NotCreatable, Service
7159
+ *
7160
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HeatmapQueryService)
7161
+ */
7162
+ interface HeatmapQueryService extends Instance {
7163
+ /**
7164
+ * **DO NOT USE!**
7165
+ *
7166
+ * This field exists to force TypeScript to recognize this as a nominal type
7167
+ * @hidden
7168
+ * @deprecated
7169
+ */
7170
+ readonly _nominal_HeatmapQueryService: unique symbol;
7171
+ }
7140
7172
  /**
7141
7173
  * - **Tags**: NotCreatable, Service
7142
7174
  *
@@ -9353,7 +9385,7 @@ interface WedgePart extends FormFactorPart {
9353
9385
  readonly _nominal_WedgePart: unique symbol;
9354
9386
  }
9355
9387
  /**
9356
- * Terrain lets you to create dynamically morphable environments.
9388
+ * `Terrain` lets you to create dynamically morphable environments.
9357
9389
  *
9358
9390
  * - **Tags**: NotCreatable
9359
9391
  *
@@ -9369,7 +9401,7 @@ interface Terrain extends BasePart {
9369
9401
  */
9370
9402
  readonly _nominal_Terrain: unique symbol;
9371
9403
  /**
9372
- * **Deprecated:** Since all places now automatically use the new terrain engine, this method is obsolete. Do not use it for new work.
9404
+ * **Deprecated:** Since all places now automatically use the new terrain engine, this method is obsolete.
9373
9405
  *
9374
9406
  * Transforms the legacy terrain engine into the new terrain engine.
9375
9407
  *
@@ -9377,7 +9409,7 @@ interface Terrain extends BasePart {
9377
9409
  * - **Tags**:
9378
9410
  *
9379
9411
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ConvertToSmooth)
9380
- * @param this Terrain lets you to create dynamically morphable environments.
9412
+ * @param this `Terrain` lets you to create dynamically morphable environments.
9381
9413
  *
9382
9414
  * @deprecated
9383
9415
  */
@@ -9759,6 +9791,12 @@ interface Workspace extends WorldRoot {
9759
9791
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#StreamingEnabled)
9760
9792
  */
9761
9793
  set StreamingEnabled(value: boolean);
9794
+ /**
9795
+ * - **ThreadSafety**: Unsafe
9796
+ *
9797
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#ApplyRecommendedStreamingSettings)
9798
+ */
9799
+ ApplyRecommendedStreamingSettings(this: Workspace): boolean;
9762
9800
  /**
9763
9801
  * **Deprecated:**
9764
9802
  *
@@ -10761,7 +10799,7 @@ interface PlayerHydrationService extends Instance {
10761
10799
  readonly _nominal_PlayerHydrationService: unique symbol;
10762
10800
  }
10763
10801
  /**
10764
- * A container for LocalScripts to be run on the client.
10802
+ * A container for client-side scripts to be run inside `Player` objects within the `Players` service.
10765
10803
  *
10766
10804
  * - **Tags**: NotCreatable, NotReplicated
10767
10805
  *
@@ -13602,7 +13640,7 @@ interface AssetSoundEffect extends CustomSoundEffect {
13602
13640
  readonly _nominal_AssetSoundEffect: unique symbol;
13603
13641
  }
13604
13642
  /**
13605
- * - **Tags**: NotCreatable, NotBrowsable
13643
+ * - **Tags**: NotCreatable
13606
13644
  *
13607
13645
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChannelSelectorSoundEffect)
13608
13646
  */
@@ -13850,7 +13888,7 @@ interface StartPageService extends Instance {
13850
13888
  readonly _nominal_StartPageService: unique symbol;
13851
13889
  }
13852
13890
  /**
13853
- * If the game allows gear, StarterGear contains all of a player's appropriate gear. Whenever the player's character spawns, all of the contents of that player's StarterGear will get copied into the player's `Backpack`.
13891
+ * If the game allows gear, `StarterGear` is a container automatically inserted into each `Player` object when the player joins the game. Whenever the player's character spawns, the contents of that player's `StarterGear` are copied into the player's `Backpack`.
13854
13892
  *
13855
13893
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StarterGear)
13856
13894
  */
@@ -13865,7 +13903,7 @@ interface StarterGear extends Instance {
13865
13903
  readonly _nominal_StarterGear: unique symbol;
13866
13904
  }
13867
13905
  /**
13868
- * A service-level container whose contents are copied into each player's `Backpack` when the player spawns. It is generally used to hold `Tools`, but is sometimes used to hold `LocalScripts` to ensure that each player gets a copy.
13906
+ * A container whose contents are copied into each player's `Backpack` when their player character spawns. It is generally used to hold `Tools`.
13869
13907
  *
13870
13908
  * - **Tags**: NotCreatable, Service
13871
13909
  *
@@ -17058,7 +17096,7 @@ interface VideoSampler extends RBXObject {
17058
17096
  readonly _nominal_VideoSampler: unique symbol;
17059
17097
  }
17060
17098
  /**
17061
- * Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
17099
+ * Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
17062
17100
  *
17063
17101
  * - **Tags**: NotCreatable, NotReplicated
17064
17102
  *