@rbxts/types 1.0.942 → 1.0.944

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.
@@ -31,6 +31,7 @@ interface Services {
31
31
  AvatarImportService: AvatarImportService;
32
32
  AvatarSettings: AvatarSettings;
33
33
  BadgeService: BadgeService;
34
+ BranchService: BranchService;
34
35
  BugReporterService: BugReporterService;
35
36
  BulkImportService: BulkImportService;
36
37
  CacheableContentProvider: CacheableContentProvider;
@@ -110,6 +111,7 @@ interface Services {
110
111
  InsertService: InsertService;
111
112
  InstanceExtensionsService: InstanceExtensionsService;
112
113
  InstanceFileSyncService: InstanceFileSyncService;
114
+ IntentService: IntentService;
113
115
  InternalMessagingService: InternalMessagingService;
114
116
  InternalMessagingServiceVerifier: InternalMessagingServiceVerifier;
115
117
  InternalSyncService: InternalSyncService;
@@ -207,6 +209,7 @@ interface Services {
207
209
  ScriptEditorService: ScriptEditorService;
208
210
  ScriptProfilerService: ScriptProfilerService;
209
211
  ScriptRegistrationService: ScriptRegistrationService;
212
+ ScriptScannerService: ScriptScannerService;
210
213
  Selection: Selection;
211
214
  SelectionHighlightManager: SelectionHighlightManager;
212
215
  SerializationService: SerializationService;
@@ -338,6 +341,7 @@ interface CreatableInstances {
338
341
  AudioSpeechToText: AudioSpeechToText;
339
342
  AudioTextToSpeech: AudioTextToSpeech;
340
343
  AudioTremolo: AudioTremolo;
344
+ AudioWindSynthesizer: AudioWindSynthesizer;
341
345
  AuroraScript: AuroraScript;
342
346
  AvatarAbilityRules: AvatarAbilityRules;
343
347
  AvatarAccessoryRules: AvatarAccessoryRules;
@@ -486,6 +490,7 @@ interface CreatableInstances {
486
490
  PitchShiftSoundEffect: PitchShiftSoundEffect;
487
491
  Plane: Plane;
488
492
  PlaneConstraint: PlaneConstraint;
493
+ PlayerControlState: PlayerControlState;
489
494
  PluginAction: PluginAction;
490
495
  PluginCapabilities: PluginCapabilities;
491
496
  PointLight: PointLight;
@@ -597,6 +602,7 @@ interface CreatableInstances {
597
602
  VideoDisplay: VideoDisplay;
598
603
  VideoFrame: VideoFrame;
599
604
  VideoPlayer: VideoPlayer;
605
+ ViewportCamera: ViewportCamera;
600
606
  ViewportFrame: ViewportFrame;
601
607
  VisualizationMode: VisualizationMode;
602
608
  VisualizationModeCategory: VisualizationModeCategory;
@@ -824,6 +830,7 @@ interface Objects extends Instances {
824
830
  EditableImage: EditableImage;
825
831
  EditableMesh: EditableMesh;
826
832
  ExecutedRemoteCommand: ExecutedRemoteCommand;
833
+ Logger: Logger;
827
834
  LuauExpression: LuauExpression;
828
835
  MLSession: MLSession;
829
836
  Object: RBXObject;
@@ -1107,6 +1114,8 @@ interface Accessory extends Accoutrement {
1107
1114
  /**
1108
1115
  * **Deprecated:** This class has been superseded by the `Accessory` class. Do not use it for new work.
1109
1116
  *
1117
+ * A deprecated accessory container superseded by `Accessory`.
1118
+ *
1110
1119
  * - **Tags**:
1111
1120
  *
1112
1121
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Hat)
@@ -1581,6 +1590,8 @@ interface AssetCounterService extends Instance {
1581
1590
  readonly _nominal_AssetCounterService: unique symbol;
1582
1591
  }
1583
1592
  /**
1593
+ * Runs a local HTTP server that serves assets to real devices.
1594
+ *
1584
1595
  * - **Tags**: NotCreatable, Service, NotReplicated
1585
1596
  *
1586
1597
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetDeliveryProxy)
@@ -1626,6 +1637,8 @@ interface AssetManagerService extends Instance {
1626
1637
  readonly _nominal_AssetManagerService: unique symbol;
1627
1638
  }
1628
1639
  /**
1640
+ * Configures a single patch asset built by `IncrementalPatchBuilder` and served through `AssetDeliveryProxy`.
1641
+ *
1629
1642
  * - **Tags**: NotCreatable, NotReplicated
1630
1643
  *
1631
1644
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetPatchSettings)
@@ -2111,6 +2124,21 @@ interface AudioTremolo extends Instance {
2111
2124
  */
2112
2125
  readonly _nominal_AudioTremolo: unique symbol;
2113
2126
  }
2127
+ /**
2128
+ * - **Tags**: NotBrowsable
2129
+ *
2130
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioWindSynthesizer)
2131
+ */
2132
+ interface AudioWindSynthesizer extends Instance {
2133
+ /**
2134
+ * **DO NOT USE!**
2135
+ *
2136
+ * This field exists to force TypeScript to recognize this as a nominal type
2137
+ * @hidden
2138
+ * @deprecated
2139
+ */
2140
+ readonly _nominal_AudioWindSynthesizer: unique symbol;
2141
+ }
2114
2142
  /**
2115
2143
  * - **Tags**: NotCreatable
2116
2144
  *
@@ -2622,6 +2650,8 @@ interface StarterGui extends BasePlayerGui {
2622
2650
  ProcessUserInput: boolean;
2623
2651
  }
2624
2652
  /**
2653
+ * Abstract base class inherited by `RemoteEvent` and `UnreliableRemoteEvent` for asynchronous, one-way communication across the client-server boundary.
2654
+ *
2625
2655
  * - **Tags**: NotCreatable
2626
2656
  *
2627
2657
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseRemoteEvent)
@@ -2667,6 +2697,8 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
2667
2697
  readonly _nominal_UnreliableRemoteEvent: unique symbol;
2668
2698
  }
2669
2699
  /**
2700
+ * Abstract base class for `WrapTarget` and `WrapLayer` that stores cage mesh data for layered clothing deformation.
2701
+ *
2670
2702
  * - **Tags**: NotCreatable
2671
2703
  *
2672
2704
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseWrap)
@@ -2681,6 +2713,8 @@ interface BaseWrap extends Instance {
2681
2713
  */
2682
2714
  readonly _nominal_BaseWrap: unique symbol;
2683
2715
  /**
2716
+ * The cage mesh this wrap uses to deform geometry, stored as a `Content` value.
2717
+ *
2684
2718
  * - **ThreadSafety**: ReadSafe
2685
2719
  *
2686
2720
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseWrap#CageMeshContent)
@@ -2749,6 +2783,8 @@ interface WrapLayer extends BaseWrap {
2749
2783
  */
2750
2784
  set BindOffset(value: CFrame);
2751
2785
  /**
2786
+ * The reference mesh that defines the Inner Cage of the `WrapLayer`, stored as a `Content` value.
2787
+ *
2752
2788
  * - **ThreadSafety**: ReadSafe
2753
2789
  *
2754
2790
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ReferenceMeshContent)
@@ -3040,6 +3076,21 @@ interface BodyPartDescription extends Instance {
3040
3076
  */
3041
3077
  readonly _nominal_BodyPartDescription: unique symbol;
3042
3078
  }
3079
+ /**
3080
+ * - **Tags**: NotCreatable, Service
3081
+ *
3082
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BranchService)
3083
+ */
3084
+ interface BranchService extends Instance {
3085
+ /**
3086
+ * **DO NOT USE!**
3087
+ *
3088
+ * This field exists to force TypeScript to recognize this as a nominal type
3089
+ * @hidden
3090
+ * @deprecated
3091
+ */
3092
+ readonly _nominal_BranchService: unique symbol;
3093
+ }
3043
3094
  /**
3044
3095
  * - **Tags**: NotReplicated
3045
3096
  *
@@ -3103,6 +3154,8 @@ interface CacheableContentProvider extends Instance {
3103
3154
  readonly _nominal_CacheableContentProvider: unique symbol;
3104
3155
  }
3105
3156
  /**
3157
+ * A service that fetches and caches SLIM (Scalable Lightweight Interactive Models) asset content representations for model rendering.
3158
+ *
3106
3159
  * - **Tags**: NotCreatable, Service
3107
3160
  *
3108
3161
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimContentProvider)
@@ -3178,33 +3231,38 @@ interface ChangeHistoryService extends Instance {
3178
3231
  */
3179
3232
  FinishRecording(this: ChangeHistoryService, identifier: string, operation: CastsToEnum<Enum.FinishRecordingOperation>, finalOptions?: object): void;
3180
3233
  /**
3181
- * Returns whether there are actions that can be redone, and, if there are, returns the last of them.
3234
+ * Returns whether there is an action available to redo and, if so, the name of that action.
3182
3235
  *
3183
3236
  * - **ThreadSafety**: Unsafe
3184
3237
  *
3185
3238
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#GetCanRedo)
3186
3239
  * @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
3240
+ * @returns `true` followed by the name of the action that would be redone when a redo is available; otherwise `false`.
3187
3241
  */
3188
3242
  GetCanRedo(this: ChangeHistoryService): unknown;
3189
3243
  /**
3190
- * Returns whether there are actions that can be undone, and, if there are, returns the last of them.
3244
+ * Returns whether there is an action available to undo and, if so, the name of that action.
3191
3245
  *
3192
3246
  * - **ThreadSafety**: Unsafe
3193
3247
  *
3194
3248
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#GetCanUndo)
3195
3249
  * @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
3250
+ * @returns `true` followed by the name of the action that would be undone when an undo is available; otherwise `false`.
3196
3251
  */
3197
3252
  GetCanUndo(this: ChangeHistoryService): unknown;
3198
3253
  /**
3254
+ * Returns whether the plugin currently has a recording in progress, optionally checking for a specific recording identifier.
3255
+ *
3199
3256
  * - **ThreadSafety**: Unsafe
3200
3257
  *
3201
3258
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#IsRecordingInProgress)
3202
3259
  * @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
3203
- * @param identifier
3260
+ * @param identifier Optional identifier of a specific recording to check for. When omitted, the method reports whether *any* recording is in progress for the plugin.
3261
+ * @returns `true` if a matching recording is in progress; otherwise `false`.
3204
3262
  */
3205
3263
  IsRecordingInProgress(this: ChangeHistoryService, identifier?: string): boolean;
3206
3264
  /**
3207
- * Executes the last action that was undone.
3265
+ * Re-executes the most recently undone action, advancing forward through the undo/redo history.
3208
3266
  *
3209
3267
  * - **ThreadSafety**: Unsafe
3210
3268
  *
@@ -3213,7 +3271,7 @@ interface ChangeHistoryService extends Instance {
3213
3271
  */
3214
3272
  Redo(this: ChangeHistoryService): void;
3215
3273
  /**
3216
- * Clears the history, causing all undo/redo waypoints to be removed.
3274
+ * Clears the undo/redo history by collapsing it into a single base waypoint.
3217
3275
  *
3218
3276
  * - **ThreadSafety**: Unsafe
3219
3277
  *
@@ -3228,7 +3286,7 @@ interface ChangeHistoryService extends Instance {
3228
3286
  *
3229
3287
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#SetEnabled)
3230
3288
  * @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
3231
- * @param state
3289
+ * @param state Whether to enable (`true`) or disable (`false`) the service.
3232
3290
  */
3233
3291
  SetEnabled(this: ChangeHistoryService, state: boolean): void;
3234
3292
  /**
@@ -3238,7 +3296,7 @@ interface ChangeHistoryService extends Instance {
3238
3296
  *
3239
3297
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#SetWaypoint)
3240
3298
  * @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
3241
- * @param name
3299
+ * @param name The name to assign to the new waypoint, which appears in the undo/redo history.
3242
3300
  */
3243
3301
  SetWaypoint(this: ChangeHistoryService, name: string): void;
3244
3302
  /**
@@ -3250,10 +3308,11 @@ interface ChangeHistoryService extends Instance {
3250
3308
  * @param this **Must** be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.
3251
3309
  * @param name Name of the action being performed suitable for logging and coding purposes.
3252
3310
  * @param displayName Name of the action being performed to display to the user.
3311
+ * @returns A unique string identifier for the recording on success, or `nil` if the recording could not be started.
3253
3312
  */
3254
3313
  TryBeginRecording(this: ChangeHistoryService, name: string, displayName?: string): string | undefined;
3255
3314
  /**
3256
- * Undos the last action taken, for which there exists a waypoint.
3315
+ * Reverts the most recent action, stepping backward through the undo/redo history.
3257
3316
  *
3258
3317
  * - **ThreadSafety**: Unsafe
3259
3318
  *
@@ -3278,7 +3337,7 @@ interface ChangeHistoryService extends Instance {
3278
3337
  */
3279
3338
  readonly OnRecordingStarted: RBXScriptSignal<(name: string, displayName?: string) => void>;
3280
3339
  /**
3281
- * Fired when the user reverses the undo command. Waypoint describes the type action that has been redone.
3340
+ * Fires after an action is redone, reporting the name of the action that was replayed.
3282
3341
  *
3283
3342
  * - **ThreadSafety**: Unsafe
3284
3343
  *
@@ -3286,7 +3345,7 @@ interface ChangeHistoryService extends Instance {
3286
3345
  */
3287
3346
  readonly OnRedo: RBXScriptSignal<(waypoint: string) => void>;
3288
3347
  /**
3289
- * Fired when the user undoes an action in studio. Waypoint describes the type action that has been undone.
3348
+ * Fires after an action is undone, reporting the name of the action that was reverted.
3290
3349
  *
3291
3350
  * - **ThreadSafety**: Unsafe
3292
3351
  *
@@ -3637,6 +3696,8 @@ interface Configuration extends Instance {
3637
3696
  readonly _nominal_Configuration: unique symbol;
3638
3697
  }
3639
3698
  /**
3699
+ * Configures a server's `DataModel` for a place session during game-server startup.
3700
+ *
3640
3701
  * - **Tags**: NotCreatable, Service
3641
3702
  *
3642
3703
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigureServerService)
@@ -4097,6 +4158,8 @@ interface VehicleController extends Controller {
4097
4158
  readonly _nominal_VehicleController: unique symbol;
4098
4159
  }
4099
4160
  /**
4161
+ * Abstract base class for the controllers that a `ControllerManager` uses to move its character.
4162
+ *
4100
4163
  * - **Tags**: NotCreatable
4101
4164
  *
4102
4165
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerBase)
@@ -4112,6 +4175,8 @@ interface ControllerBase extends Instance {
4112
4175
  readonly _nominal_ControllerBase: unique symbol;
4113
4176
  }
4114
4177
  /**
4178
+ * A physics character controller that governs movement while a character is airborne.
4179
+ *
4115
4180
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AirController)
4116
4181
  */
4117
4182
  interface AirController extends ControllerBase {
@@ -4125,6 +4190,8 @@ interface AirController extends ControllerBase {
4125
4190
  readonly _nominal_AirController: unique symbol;
4126
4191
  }
4127
4192
  /**
4193
+ * A physics character controller that moves its `ControllerManager.RootPart` along a climbable surface, such as a ladder.
4194
+ *
4128
4195
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ClimbController)
4129
4196
  */
4130
4197
  interface ClimbController extends ControllerBase {
@@ -4138,6 +4205,8 @@ interface ClimbController extends ControllerBase {
4138
4205
  readonly _nominal_ClimbController: unique symbol;
4139
4206
  }
4140
4207
  /**
4208
+ * The `ControllerBase` that moves a `ControllerManager` character while it is walking or standing on the ground.
4209
+ *
4141
4210
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GroundController)
4142
4211
  */
4143
4212
  interface GroundController extends ControllerBase {
@@ -4151,6 +4220,8 @@ interface GroundController extends ControllerBase {
4151
4220
  readonly _nominal_GroundController: unique symbol;
4152
4221
  }
4153
4222
  /**
4223
+ * The `ControllerBase` that moves a `ControllerManager` character while it is swimming.
4224
+ *
4154
4225
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SwimController)
4155
4226
  */
4156
4227
  interface SwimController extends ControllerBase {
@@ -4241,6 +4312,8 @@ interface CreationDBService extends Instance {
4241
4312
  readonly _nominal_CreationDBService: unique symbol;
4242
4313
  }
4243
4314
  /**
4315
+ * Provides methods for querying Creator Store product information and purchasing assets.
4316
+ *
4244
4317
  * - **Tags**: NotCreatable, Service
4245
4318
  *
4246
4319
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CreatorStoreService)
@@ -4271,6 +4344,8 @@ interface CrossDMScriptChangeListener extends Instance {
4271
4344
  readonly _nominal_CrossDMScriptChangeListener: unique symbol;
4272
4345
  }
4273
4346
  /**
4347
+ * Internal-only instance that writes text to a file in the engine's logs directory.
4348
+ *
4274
4349
  * - **Tags**: NotReplicated
4275
4350
  *
4276
4351
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CustomLog)
@@ -4420,6 +4495,8 @@ interface DataModelSession extends Instance {
4420
4495
  readonly _nominal_DataModelSession: unique symbol;
4421
4496
  }
4422
4497
  /**
4498
+ * Specifies additional parameters for a `GlobalDataStore:GetAsync()` call.
4499
+ *
4423
4500
  * - **Tags**: NotReplicated
4424
4501
  *
4425
4502
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreGetOptions)
@@ -4957,6 +5034,8 @@ interface Dragger extends Instance {
4957
5034
  readonly _nominal_Dragger: unique symbol;
4958
5035
  }
4959
5036
  /**
5037
+ * A service that centralizes the global dragger settings that Studio's dragging tools read so they move, snap, and highlight objects consistently.
5038
+ *
4960
5039
  * - **Tags**: NotCreatable, Service, NotReplicated
4961
5040
  *
4962
5041
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService)
@@ -6225,6 +6304,8 @@ interface GlobalDataStore extends Instance {
6225
6304
  readonly _nominal_GlobalDataStore: unique symbol;
6226
6305
  }
6227
6306
  /**
6307
+ * A `GlobalDataStore` that also supports versioning, key metadata, and enumerating keys.
6308
+ *
6228
6309
  * - **Tags**: NotCreatable, NotReplicated
6229
6310
  *
6230
6311
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStore)
@@ -6642,6 +6723,8 @@ interface BillboardGui extends LayerCollector {
6642
6723
  readonly _nominal_BillboardGui: unique symbol;
6643
6724
  }
6644
6725
  /**
6726
+ * An abstract base class for GUIs that display `GuiObjects` in Roblox Studio widgets.
6727
+ *
6645
6728
  * - **Tags**: NotCreatable, NotReplicated
6646
6729
  *
6647
6730
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginGui)
@@ -6661,7 +6744,7 @@ interface PluginGui extends LayerCollector {
6661
6744
  * - **ThreadSafety**: Unsafe
6662
6745
  *
6663
6746
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginGui#GetRelativeMousePosition)
6664
- * @param this
6747
+ * @param this An abstract base class for GUIs that display `GuiObjects` in Roblox Studio widgets.
6665
6748
  * @returns The screen position of the mouse relative to the PluginGui in pixels.
6666
6749
  */
6667
6750
  GetRelativeMousePosition(this: PluginGui): Vector2;
@@ -6715,6 +6798,8 @@ interface PluginGui extends LayerCollector {
6715
6798
  readonly WindowFocused: RBXScriptSignal<() => void>;
6716
6799
  }
6717
6800
  /**
6801
+ * A `PluginGui` that displays its contents in a dockable, resizable Roblox Studio window.
6802
+ *
6718
6803
  * - **Tags**: NotCreatable, NotReplicated
6719
6804
  *
6720
6805
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DockWidgetPluginGui)
@@ -6760,6 +6845,8 @@ interface ScreenGui extends LayerCollector {
6760
6845
  readonly _nominal_ScreenGui: unique symbol;
6761
6846
  }
6762
6847
  /**
6848
+ * Base class for containers that render `GuiObjects` onto a face of a `BasePart` in the 3D world.
6849
+ *
6763
6850
  * - **Tags**: NotCreatable
6764
6851
  *
6765
6852
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceGuiBase)
@@ -7221,6 +7308,8 @@ interface GuiService extends Instance {
7221
7308
  readonly _nominal_GuiService: unique symbol;
7222
7309
  }
7223
7310
  /**
7311
+ * An object that provides waveform-based haptic feedback (vibrations and rumbles) on supported controllers and mobile devices.
7312
+ *
7224
7313
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect)
7225
7314
  */
7226
7315
  interface HapticEffect extends Instance {
@@ -7266,7 +7355,7 @@ interface HarmonyService extends Instance {
7266
7355
  readonly _nominal_HarmonyService: unique symbol;
7267
7356
  }
7268
7357
  /**
7269
- * Provides methods which return Luau heap memory usage summaries on client and server.
7358
+ * Generates and retrieves Luau heap memory profiles from the client and server Luau virtual machines for memory debugging.
7270
7359
  *
7271
7360
  * - **Tags**: NotCreatable, Service
7272
7361
  *
@@ -7282,27 +7371,31 @@ interface HeapProfilerService extends Instance {
7282
7371
  */
7283
7372
  readonly _nominal_HeapProfilerService: unique symbol;
7284
7373
  /**
7285
- * Returns a summary of Luau heap memory usage for the requested player's client.
7374
+ * Yields until the Luau heap profile of the specified player's client is available, then returns it as a JSON string.
7286
7375
  *
7287
7376
  * - **ThreadSafety**: Unsafe
7288
7377
  * - **Tags**: Yields
7289
7378
  *
7290
7379
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HeapProfilerService#ClientRequestDataAsync)
7291
- * @param this Provides methods which return Luau heap memory usage summaries on client and server.
7292
- * @param player
7380
+ * @param this Generates and retrieves Luau heap memory profiles from the client and server Luau virtual machines for memory debugging.
7381
+ * @param player The `Player` whose client Luau heap should be profiled.
7382
+ * @returns A JSON-encoded string containing the client's Luau heap profile.
7293
7383
  */
7294
7384
  ClientRequestDataAsync(this: HeapProfilerService, player: Player): string;
7295
7385
  /**
7296
- * Returns a summary of Luau heap memory usage on the client.
7386
+ * Yields until the server's Luau heap profile is available, then returns it as a JSON string.
7297
7387
  *
7298
7388
  * - **ThreadSafety**: Unsafe
7299
7389
  * - **Tags**: Yields
7300
7390
  *
7301
7391
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HeapProfilerService#ServerRequestDataAsync)
7302
- * @param this Provides methods which return Luau heap memory usage summaries on client and server.
7392
+ * @param this Generates and retrieves Luau heap memory profiles from the client and server Luau virtual machines for memory debugging.
7393
+ * @returns A JSON-encoded string containing the server's Luau heap profile.
7303
7394
  */
7304
7395
  ServerRequestDataAsync(this: HeapProfilerService): string;
7305
7396
  /**
7397
+ * Fires on the requesting machine with the compressed Luau heap profile produced for an earlier request.
7398
+ *
7306
7399
  * - **ThreadSafety**: Unsafe
7307
7400
  *
7308
7401
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HeapProfilerService#OnNewData)
@@ -7355,6 +7448,8 @@ interface HeightmapImporterService extends Instance {
7355
7448
  readonly _nominal_HeightmapImporterService: unique symbol;
7356
7449
  }
7357
7450
  /**
7451
+ * Stores the precomputed hidden surface removal (HSR) data for a layered-clothing wrap, marking the mesh faces that are hidden by higher clothing layers so the engine can cull them.
7452
+ *
7358
7453
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HiddenSurfaceRemovalAsset)
7359
7454
  */
7360
7455
  interface HiddenSurfaceRemovalAsset extends Instance {
@@ -7473,6 +7568,8 @@ interface IKControl extends Instance {
7473
7568
  readonly _nominal_IKControl: unique symbol;
7474
7569
  }
7475
7570
  /**
7571
+ * Internal Studio-only base interface for a Studio bridge service. Declares no scriptable members.
7572
+ *
7476
7573
  * - **Tags**: NotCreatable, Service
7477
7574
  *
7478
7575
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ILegacyStudioBridge)
@@ -7563,6 +7660,8 @@ interface AssetImportSession extends ImportSession {
7563
7660
  readonly _nominal_AssetImportSession: unique symbol;
7564
7661
  }
7565
7662
  /**
7663
+ * Builds signed incremental patches for hot-reloading a running client from script changes detected by a separate file watcher.
7664
+ *
7566
7665
  * - **Tags**: NotCreatable, Service, NotReplicated
7567
7666
  *
7568
7667
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder)
@@ -7728,6 +7827,21 @@ interface InstanceFileSyncService extends Instance {
7728
7827
  */
7729
7828
  readonly StatusChanged: RBXScriptSignal<(instance: Instance, status: Enum.InstanceFileSyncStatus) => void>;
7730
7829
  }
7830
+ /**
7831
+ * - **Tags**: NotCreatable, Service, NotReplicated
7832
+ *
7833
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IntentService)
7834
+ */
7835
+ interface IntentService extends Instance {
7836
+ /**
7837
+ * **DO NOT USE!**
7838
+ *
7839
+ * This field exists to force TypeScript to recognize this as a nominal type
7840
+ * @hidden
7841
+ * @deprecated
7842
+ */
7843
+ readonly _nominal_IntentService: unique symbol;
7844
+ }
7731
7845
  /**
7732
7846
  * - **Tags**: NotCreatable, Service, NotReplicated
7733
7847
  *
@@ -7844,6 +7958,8 @@ interface RotateP extends DynamicRotate {
7844
7958
  /**
7845
7959
  * **Deprecated:** This class works alongside the deprecated `SurfaceType` and should not be used for future work; use `HingeConstraint` instead.
7846
7960
  *
7961
+ * Joins two parts and allows rotation driven by angular velocity from the Motor surface type.
7962
+ *
7847
7963
  * - **Tags**:
7848
7964
  *
7849
7965
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RotateV)
@@ -8015,6 +8131,8 @@ interface Snap extends JointInstance {
8015
8131
  readonly _nominal_Snap: unique symbol;
8016
8132
  }
8017
8133
  /**
8134
+ * A `Motor`-like `JointInstance` that forms its connection using a `MotorFeature` and a `Hole`.
8135
+ *
8018
8136
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VelocityMotor)
8019
8137
  */
8020
8138
  interface VelocityMotor extends JointInstance {
@@ -8028,6 +8146,8 @@ interface VelocityMotor extends JointInstance {
8028
8146
  readonly _nominal_VelocityMotor: unique symbol;
8029
8147
  }
8030
8148
  /**
8149
+ * Holds two `BaseParts` together in a fixed relative position, regardless of whether they're touching.
8150
+ *
8031
8151
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Weld)
8032
8152
  */
8033
8153
  interface Weld extends JointInstance {
@@ -9100,11 +9220,13 @@ interface NetworkPeer extends Instance {
9100
9220
  *
9101
9221
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/NetworkPeer#SetOutgoingKBPSLimit)
9102
9222
  * @param this The `NetworkPeer` object is the most basic class of the network objects.
9103
- * @param limit
9223
+ * @param limit The maximum outgoing bandwidth, in kilobits per second (1,000 bits/second). The value is clamped to the range `10`–`10,000`; a value of `0` or less removes the limit entirely.
9104
9224
  */
9105
9225
  SetOutgoingKBPSLimit(this: NetworkPeer, limit: number): void;
9106
9226
  }
9107
9227
  /**
9228
+ * A service that manages a network connection's properties server.
9229
+ *
9108
9230
  * - **Tags**: NotCreatable, Service, NotReplicated
9109
9231
  *
9110
9232
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/NetworkClient)
@@ -9120,6 +9242,8 @@ interface NetworkClient extends NetworkPeer {
9120
9242
  readonly _nominal_NetworkClient: unique symbol;
9121
9243
  }
9122
9244
  /**
9245
+ * A server-side service that manages all `NetworkReplicator` instances and handles incoming client connections.
9246
+ *
9123
9247
  * - **Tags**: NotCreatable, Service, NotReplicated
9124
9248
  *
9125
9249
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/NetworkServer)
@@ -9152,6 +9276,8 @@ interface NetworkReplicator extends Instance {
9152
9276
  readonly _nominal_NetworkReplicator: unique symbol;
9153
9277
  }
9154
9278
  /**
9279
+ * The client-side `NetworkReplicator` that manages replication of data model changes between the server and itself.
9280
+ *
9155
9281
  * - **Tags**: NotCreatable, NotReplicated
9156
9282
  *
9157
9283
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ClientReplicator)
@@ -9167,6 +9293,8 @@ interface ClientReplicator extends NetworkReplicator {
9167
9293
  readonly _nominal_ClientReplicator: unique symbol;
9168
9294
  }
9169
9295
  /**
9296
+ * The server-side `NetworkReplicator` that manages replication of data model changes between the server to a single connected client.
9297
+ *
9170
9298
  * - **Tags**: NotCreatable, NotReplicated
9171
9299
  *
9172
9300
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ServerReplicator)
@@ -9739,6 +9867,19 @@ interface Camera extends PVInstance {
9739
9867
  */
9740
9868
  readonly _nominal_Camera: unique symbol;
9741
9869
  }
9870
+ /**
9871
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ViewportCamera)
9872
+ */
9873
+ interface ViewportCamera extends Camera {
9874
+ /**
9875
+ * **DO NOT USE!**
9876
+ *
9877
+ * This field exists to force TypeScript to recognize this as a nominal type
9878
+ * @hidden
9879
+ * @deprecated
9880
+ */
9881
+ readonly _nominal_ViewportCamera: unique symbol;
9882
+ }
9742
9883
  /**
9743
9884
  * Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
9744
9885
  *
@@ -9926,9 +10067,13 @@ interface Workspace extends WorldRoot {
9926
10067
  */
9927
10068
  set StreamingEnabled(value: boolean);
9928
10069
  /**
10070
+ * Applies Roblox's recommended instance streaming settings to the `Workspace`.
10071
+ *
9929
10072
  * - **ThreadSafety**: Unsafe
9930
10073
  *
9931
10074
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#ApplyRecommendedStreamingSettings)
10075
+ * @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
10076
+ * @returns `true` if one or more streaming properties were changed; `false` if every value already matched its recommended setting.
9932
10077
  */
9933
10078
  ApplyRecommendedStreamingSettings(this: Workspace): boolean;
9934
10079
  /**
@@ -10004,6 +10149,8 @@ interface PackageLink extends Instance {
10004
10149
  readonly _nominal_PackageLink: unique symbol;
10005
10150
  }
10006
10151
  /**
10152
+ * Manages Roblox Studio packages, tracking their metadata and versions and handling updates to package contents.
10153
+ *
10007
10154
  * - **Tags**: NotCreatable, Service, NotReplicated
10008
10155
  *
10009
10156
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PackageService)
@@ -10117,6 +10264,8 @@ interface CapturesPages extends Pages {
10117
10264
  readonly _nominal_CapturesPages: unique symbol;
10118
10265
  }
10119
10266
  /**
10267
+ * A special version of `Pages` that stores the results of an Avatar Editor catalog search.
10268
+ *
10120
10269
  * - **Tags**: NotCreatable, NotReplicated
10121
10270
  *
10122
10271
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CatalogPages)
@@ -10226,6 +10375,8 @@ interface FriendPages extends Pages<{
10226
10375
  readonly _nominal_FriendPages: unique symbol;
10227
10376
  }
10228
10377
  /**
10378
+ * A special version of `Pages` that contains information about a specific category of a user's inventory.
10379
+ *
10229
10380
  * - **Tags**: NotCreatable, NotReplicated
10230
10381
  *
10231
10382
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InventoryPages)
@@ -10296,6 +10447,8 @@ interface RecommendationPages extends Pages {
10296
10447
  readonly _nominal_RecommendationPages: unique symbol;
10297
10448
  }
10298
10449
  /**
10450
+ * A generic Pages object that can contain variable data depending on the method that returned it.
10451
+ *
10299
10452
  * - **Tags**: NotCreatable, NotReplicated
10300
10453
  *
10301
10454
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StandardPages)
@@ -10508,6 +10661,8 @@ interface PerformanceControlService extends Instance {
10508
10661
  readonly _nominal_PerformanceControlService: unique symbol;
10509
10662
  }
10510
10663
  /**
10664
+ * Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
10665
+ *
10511
10666
  * - **Tags**: NotCreatable, Service
10512
10667
  *
10513
10668
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService)
@@ -10897,6 +11052,21 @@ interface Player extends Instance {
10897
11052
  SetSuperSafeChat(this: Player, value: boolean): void;
10898
11053
  readonly Name: string;
10899
11054
  }
11055
+ /**
11056
+ * - **Tags**: NotBrowsable
11057
+ *
11058
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState)
11059
+ */
11060
+ interface PlayerControlState extends Instance {
11061
+ /**
11062
+ * **DO NOT USE!**
11063
+ *
11064
+ * This field exists to force TypeScript to recognize this as a nominal type
11065
+ * @hidden
11066
+ * @deprecated
11067
+ */
11068
+ readonly _nominal_PlayerControlState: unique symbol;
11069
+ }
10900
11070
  /**
10901
11071
  * - **Tags**: NotCreatable, NotReplicated
10902
11072
  *
@@ -11054,6 +11224,8 @@ interface Players extends Instance {
11054
11224
  TeamChat(this: Players, message: string): void;
11055
11225
  }
11056
11226
  /**
11227
+ * The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11228
+ *
11057
11229
  * - **Tags**: NotCreatable
11058
11230
  *
11059
11231
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin)
@@ -11073,7 +11245,7 @@ interface Plugin extends Instance {
11073
11245
  * - **ThreadSafety**: Unsafe
11074
11246
  *
11075
11247
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Activate)
11076
- * @param this
11248
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11077
11249
  * @param exclusiveMouse A boolean specifying whether to activate the plugin with exclusive mouse. If `true`, a `PluginMouse` can be retrieved via `GetMouse()`.
11078
11250
  */
11079
11251
  Activate(this: Plugin, exclusiveMouse: boolean): void;
@@ -11083,7 +11255,7 @@ interface Plugin extends Instance {
11083
11255
  * - **ThreadSafety**: Unsafe
11084
11256
  *
11085
11257
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreatePluginAction)
11086
- * @param this
11258
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11087
11259
  * @param actionId Must be a unique string that identifies this PluginAction from others.
11088
11260
  * @param text The displayed name of the action.
11089
11261
  * @param statusTip The displayed description of the action.
@@ -11097,7 +11269,7 @@ interface Plugin extends Instance {
11097
11269
  * - **ThreadSafety**: Unsafe
11098
11270
  *
11099
11271
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreatePluginMenu)
11100
- * @param this
11272
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11101
11273
  * @param id Unique ID for the menu.
11102
11274
  * @param title The text to be displayed when used as a submenu.
11103
11275
  * @param icon The icon to be displayed when used as a submenu.
@@ -11109,7 +11281,7 @@ interface Plugin extends Instance {
11109
11281
  * - **ThreadSafety**: Unsafe
11110
11282
  *
11111
11283
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreateToolbar)
11112
- * @param this
11284
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11113
11285
  * @param name The visible text on the toolbar, labeling the group of buttons contained within.
11114
11286
  */
11115
11287
  CreateToolbar(this: Plugin, name: string): PluginToolbar;
@@ -11119,7 +11291,7 @@ interface Plugin extends Instance {
11119
11291
  * - **ThreadSafety**: Unsafe
11120
11292
  *
11121
11293
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Deactivate)
11122
- * @param this
11294
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11123
11295
  */
11124
11296
  Deactivate(this: Plugin): void;
11125
11297
  /**
@@ -11128,7 +11300,7 @@ interface Plugin extends Instance {
11128
11300
  * - **ThreadSafety**: Unsafe
11129
11301
  *
11130
11302
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#GetJoinMode)
11131
- * @param this
11303
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11132
11304
  */
11133
11305
  GetJoinMode(this: Plugin): Enum.JointCreationMode;
11134
11306
  /**
@@ -11137,7 +11309,7 @@ interface Plugin extends Instance {
11137
11309
  * - **ThreadSafety**: Unsafe
11138
11310
  *
11139
11311
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#GetMouse)
11140
- * @param this
11312
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11141
11313
  */
11142
11314
  GetMouse(this: Plugin): PluginMouse;
11143
11315
  /**
@@ -11146,7 +11318,7 @@ interface Plugin extends Instance {
11146
11318
  * - **ThreadSafety**: Unsafe
11147
11319
  *
11148
11320
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#GetSelectedRibbonTool)
11149
- * @param this
11321
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11150
11322
  */
11151
11323
  GetSelectedRibbonTool(this: Plugin): Enum.RibbonTool;
11152
11324
  /**
@@ -11155,8 +11327,8 @@ interface Plugin extends Instance {
11155
11327
  * - **ThreadSafety**: Unsafe
11156
11328
  *
11157
11329
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#GetSetting)
11158
- * @param this
11159
- * @param key
11330
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11331
+ * @param key The string key that was previously passed to `SetSetting()`.
11160
11332
  */
11161
11333
  GetSetting(this: Plugin, key: string): unknown;
11162
11334
  /**
@@ -11168,7 +11340,7 @@ interface Plugin extends Instance {
11168
11340
  * - **Tags**:
11169
11341
  *
11170
11342
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#GetStudioUserId)
11171
- * @param this
11343
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11172
11344
  *
11173
11345
  * @deprecated
11174
11346
  */
@@ -11179,8 +11351,8 @@ interface Plugin extends Instance {
11179
11351
  * - **ThreadSafety**: Unsafe
11180
11352
  *
11181
11353
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Intersect)
11182
- * @param this
11183
- * @param objects
11354
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11355
+ * @param objects The array of `BaseParts` to intersect.
11184
11356
  */
11185
11357
  Intersect(this: Plugin, objects: Array<Instance>): Instance | undefined;
11186
11358
  /**
@@ -11189,7 +11361,7 @@ interface Plugin extends Instance {
11189
11361
  * - **ThreadSafety**: Unsafe
11190
11362
  *
11191
11363
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#IsActivated)
11192
- * @param this
11364
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11193
11365
  * @returns A boolean indicating whether the plugin is currently active.
11194
11366
  */
11195
11367
  IsActivated(this: Plugin): boolean;
@@ -11199,7 +11371,7 @@ interface Plugin extends Instance {
11199
11371
  * - **ThreadSafety**: Unsafe
11200
11372
  *
11201
11373
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#IsActivatedWithExclusiveMouse)
11202
- * @param this
11374
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11203
11375
  * @returns Whether this plugin is currently active with an exclusive mouse.
11204
11376
  */
11205
11377
  IsActivatedWithExclusiveMouse(this: Plugin): boolean;
@@ -11209,8 +11381,8 @@ interface Plugin extends Instance {
11209
11381
  * - **ThreadSafety**: Unsafe
11210
11382
  *
11211
11383
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Negate)
11212
- * @param this
11213
- * @param objects
11384
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11385
+ * @param objects The array of `BaseParts` to negate.
11214
11386
  */
11215
11387
  Negate(this: Plugin, objects: Array<Instance>): Array<Instance>;
11216
11388
  /**
@@ -11222,9 +11394,9 @@ interface Plugin extends Instance {
11222
11394
  * - **Tags**:
11223
11395
  *
11224
11396
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#OpenScript)
11225
- * @param this
11226
- * @param script
11227
- * @param lineNumber
11397
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11398
+ * @param script The `LuaSourceContainer` script instance to open.
11399
+ * @param lineNumber The line number to navigate to in the editor. Defaults to `1`.
11228
11400
  *
11229
11401
  * @deprecated
11230
11402
  */
@@ -11235,8 +11407,8 @@ interface Plugin extends Instance {
11235
11407
  * - **ThreadSafety**: Unsafe
11236
11408
  *
11237
11409
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#OpenWikiPage)
11238
- * @param this
11239
- * @param url
11410
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11411
+ * @param url The URL of the wiki/documentation page to open.
11240
11412
  */
11241
11413
  OpenWikiPage(this: Plugin, url: string): void;
11242
11414
  /**
@@ -11245,7 +11417,7 @@ interface Plugin extends Instance {
11245
11417
  * - **ThreadSafety**: Unsafe
11246
11418
  *
11247
11419
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#SaveSelectedToRoblox)
11248
- * @param this
11420
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11249
11421
  */
11250
11422
  SaveSelectedToRoblox(this: Plugin): void;
11251
11423
  /**
@@ -11254,9 +11426,9 @@ interface Plugin extends Instance {
11254
11426
  * - **ThreadSafety**: Unsafe
11255
11427
  *
11256
11428
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#SelectRibbonTool)
11257
- * @param this
11258
- * @param tool
11259
- * @param position
11429
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11430
+ * @param tool The `RibbonTool` to activate.
11431
+ * @param position The `UDim2` screen position at which to show the tool's dialog window, if applicable.
11260
11432
  */
11261
11433
  SelectRibbonTool(this: Plugin, tool: CastsToEnum<Enum.RibbonTool>, position: UDim2): void;
11262
11434
  /**
@@ -11265,8 +11437,8 @@ interface Plugin extends Instance {
11265
11437
  * - **ThreadSafety**: Unsafe
11266
11438
  *
11267
11439
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Separate)
11268
- * @param this
11269
- * @param objects
11440
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11441
+ * @param objects The array of `UnionOperations` to separate.
11270
11442
  */
11271
11443
  Separate(this: Plugin, objects: Array<Instance>): Array<Instance>;
11272
11444
  /**
@@ -11275,9 +11447,9 @@ interface Plugin extends Instance {
11275
11447
  * - **ThreadSafety**: Unsafe
11276
11448
  *
11277
11449
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#SetSetting)
11278
- * @param this
11279
- * @param key
11280
- * @param value
11450
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11451
+ * @param key The string key to store the value under.
11452
+ * @param value The value to store. Must be JSON-serializable (string, number, boolean, table, or `nil`).
11281
11453
  */
11282
11454
  SetSetting(this: Plugin, key: string, value: unknown): void;
11283
11455
  /**
@@ -11286,8 +11458,8 @@ interface Plugin extends Instance {
11286
11458
  * - **ThreadSafety**: Unsafe
11287
11459
  *
11288
11460
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#StartDrag)
11289
- * @param this
11290
- * @param dragData
11461
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11462
+ * @param dragData A dictionary describing the drag, including fields such as `Sender`, `MimeType`, `Data`, `MouseIcon`, `DragIcon`, and `HotSpot`.
11291
11463
  */
11292
11464
  StartDrag(this: Plugin, dragData: object): void;
11293
11465
  /**
@@ -11296,8 +11468,8 @@ interface Plugin extends Instance {
11296
11468
  * - **ThreadSafety**: Unsafe
11297
11469
  *
11298
11470
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Union)
11299
- * @param this
11300
- * @param objects
11471
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11472
+ * @param objects The array of `BaseParts` to union together.
11301
11473
  */
11302
11474
  Union(this: Plugin, objects: Array<BasePart>): UnionOperation;
11303
11475
  /**
@@ -11309,7 +11481,7 @@ interface Plugin extends Instance {
11309
11481
  * - **Tags**: Yields
11310
11482
  *
11311
11483
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreateDockWidgetPluginGui)
11312
- * @param this
11484
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11313
11485
  * @param pluginGuiId A unique and consistent identifier used to storing the widget's dock state and other internal details.
11314
11486
  * @param dockWidgetPluginGuiInfo Describes the `DockWidgetPluginGui` to create (initial state, size, etc).
11315
11487
  *
@@ -11323,7 +11495,7 @@ interface Plugin extends Instance {
11323
11495
  * - **Tags**: Yields
11324
11496
  *
11325
11497
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreateDockWidgetPluginGuiAsync)
11326
- * @param this
11498
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11327
11499
  * @param pluginGuiId A unique and consistent identifier used to storing the widget's dock state and other internal details.
11328
11500
  * @param dockWidgetPluginGuiInfo Describes the `DockWidgetPluginGui` to create (initial state, size, etc).
11329
11501
  */
@@ -11337,9 +11509,9 @@ interface Plugin extends Instance {
11337
11509
  * - **Tags**: Yields
11338
11510
  *
11339
11511
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxAnimation)
11340
- * @param this
11341
- * @param rigModel
11342
- * @param isR15
11512
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11513
+ * @param rigModel The rig model that the imported animation will be applied to.
11514
+ * @param isR15 Whether the animation file should be interpreted as an R15 rig. Defaults to `true`.
11343
11515
  *
11344
11516
  * @deprecated ImportFbxAnimationAsync
11345
11517
  */
@@ -11351,9 +11523,9 @@ interface Plugin extends Instance {
11351
11523
  * - **Tags**: Yields
11352
11524
  *
11353
11525
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxAnimationAsync)
11354
- * @param this
11355
- * @param rigModel
11356
- * @param isR15
11526
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11527
+ * @param rigModel The rig model that the imported animation will be applied to.
11528
+ * @param isR15 Whether the animation file should be interpreted as an R15 rig. Defaults to `true`.
11357
11529
  */
11358
11530
  ImportFbxAnimationAsync(this: Plugin, rigModel: Instance, isR15?: boolean): Instance | undefined;
11359
11531
  /**
@@ -11365,8 +11537,8 @@ interface Plugin extends Instance {
11365
11537
  * - **Tags**: Yields
11366
11538
  *
11367
11539
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxRig)
11368
- * @param this
11369
- * @param isR15
11540
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11541
+ * @param isR15 Whether the rig file should be interpreted as R15. Defaults to `true`.
11370
11542
  *
11371
11543
  * @deprecated ImportFbxRigAsync
11372
11544
  */
@@ -11378,8 +11550,8 @@ interface Plugin extends Instance {
11378
11550
  * - **Tags**: Yields
11379
11551
  *
11380
11552
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxRigAsync)
11381
- * @param this
11382
- * @param isR15
11553
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11554
+ * @param isR15 Whether the rig file should be interpreted as R15. Defaults to `true`.
11383
11555
  */
11384
11556
  ImportFbxRigAsync(this: Plugin, isR15?: boolean): Instance | undefined;
11385
11557
  /**
@@ -11389,7 +11561,7 @@ interface Plugin extends Instance {
11389
11561
  * - **Tags**: Yields
11390
11562
  *
11391
11563
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptForExistingAssetId)
11392
- * @param this
11564
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11393
11565
  * @param assetType The asset type to browse. Only `Animation` is supported.
11394
11566
  */
11395
11567
  PromptForExistingAssetId(this: Plugin, assetType: string): number;
@@ -11400,7 +11572,7 @@ interface Plugin extends Instance {
11400
11572
  * - **Tags**: Yields
11401
11573
  *
11402
11574
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptForExistingAssetIdAsync)
11403
- * @param this
11575
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11404
11576
  * @param assetType The asset type to browse. Only `Animation` is supported.
11405
11577
  */
11406
11578
  PromptForExistingAssetIdAsync(this: Plugin, assetType: string): number;
@@ -11413,8 +11585,8 @@ interface Plugin extends Instance {
11413
11585
  * - **Tags**: Yields
11414
11586
  *
11415
11587
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptSaveSelection)
11416
- * @param this
11417
- * @param suggestedFileName
11588
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11589
+ * @param suggestedFileName The default file name shown in the save dialog. Defaults to an empty string.
11418
11590
  *
11419
11591
  * @deprecated PromptSaveSelectionAsync
11420
11592
  */
@@ -11426,8 +11598,8 @@ interface Plugin extends Instance {
11426
11598
  * - **Tags**: Yields
11427
11599
  *
11428
11600
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptSaveSelectionAsync)
11429
- * @param this
11430
- * @param suggestedFileName
11601
+ * @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
11602
+ * @param suggestedFileName The default file name shown in the save dialog. Defaults to an empty string.
11431
11603
  */
11432
11604
  PromptSaveSelectionAsync(this: Plugin, suggestedFileName?: string): boolean;
11433
11605
  /**
@@ -11448,6 +11620,8 @@ interface Plugin extends Instance {
11448
11620
  readonly Unloading: RBXScriptSignal<() => void>;
11449
11621
  }
11450
11622
  /**
11623
+ * Represents a generic performable action in Roblox Studio that can optionally be bound to a keyboard shortcut.
11624
+ *
11451
11625
  * - **Tags**: NotReplicated
11452
11626
  *
11453
11627
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginAction)
@@ -11471,6 +11645,8 @@ interface PluginAction extends Instance {
11471
11645
  readonly Triggered: RBXScriptSignal<() => void>;
11472
11646
  }
11473
11647
  /**
11648
+ * Declares a plugin's capabilities (the data models it targets and the permissions it requests) through a JSON manifest.
11649
+ *
11474
11650
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginCapabilities)
11475
11651
  */
11476
11652
  interface PluginCapabilities extends Instance {
@@ -11507,6 +11683,7 @@ interface PluginConnectionService extends Instance {
11507
11683
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnectionService#CanHaveConnectionType)
11508
11684
  * @param this This service is used by plugins to communicate with other instances of themselves running in other data models.
11509
11685
  * @param type The connection type to check.
11686
+ * @returns Whether the current data model can potentially have connections of the given type.
11510
11687
  */
11511
11688
  CanHaveConnectionType(this: PluginConnectionService, type: CastsToEnum<Enum.PluginConnectionTargetType>): boolean;
11512
11689
  /**
@@ -11530,6 +11707,8 @@ interface PluginConnectionService extends Instance {
11530
11707
  readonly Connected: RBXScriptSignal<(conn: PluginConnection) => void>;
11531
11708
  }
11532
11709
  /**
11710
+ * A service that holds the debuggable `Plugin` instances that are currently being debugged in Studio, parenting them into the data model.
11711
+ *
11533
11712
  * - **Tags**: NotCreatable, Service, NotReplicated
11534
11713
  *
11535
11714
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginDebugService)
@@ -11545,6 +11724,8 @@ interface PluginDebugService extends Instance {
11545
11724
  readonly _nominal_PluginDebugService: unique symbol;
11546
11725
  }
11547
11726
  /**
11727
+ * Provides information about an in-progress drag for the drag events that plugins can respond to.
11728
+ *
11548
11729
  * - **Tags**: NotCreatable, NotReplicated
11549
11730
  *
11550
11731
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginDragEvent)
@@ -11577,6 +11758,8 @@ interface PluginGuiService extends Instance {
11577
11758
  readonly _nominal_PluginGuiService: unique symbol;
11578
11759
  }
11579
11760
  /**
11761
+ * Studio service that manages installed plugins; not intended for creator scripts or plugins.
11762
+ *
11580
11763
  * - **Tags**: NotCreatable, Service, NotReplicated
11581
11764
  *
11582
11765
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginManagementService)
@@ -11592,6 +11775,8 @@ interface PluginManagementService extends Instance {
11592
11775
  readonly _nominal_PluginManagementService: unique symbol;
11593
11776
  }
11594
11777
  /**
11778
+ * The singleton object returned by the global `PluginManager()` function, exposing a small set of legacy Studio plugin utilities.
11779
+ *
11595
11780
  * - **Tags**: NotCreatable, NotReplicated
11596
11781
  *
11597
11782
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginManagerInterface)
@@ -11608,29 +11793,36 @@ interface PluginManagerInterface extends Instance {
11608
11793
  /**
11609
11794
  * **Deprecated:** The steps to create a plugin have changed. To learn more, see `Plugin`.
11610
11795
  *
11796
+ * Deprecated. Creates and returns a new `Plugin`; use `Plugin` instead.
11797
+ *
11611
11798
  * - **ThreadSafety**: Unsafe
11612
11799
  * - **Tags**: CustomLuaState
11613
11800
  *
11614
11801
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginManagerInterface#CreatePlugin)
11615
- * @param this
11802
+ * @param this The singleton object returned by the global `PluginManager()` function, exposing a small set of legacy Studio plugin utilities.
11803
+ * @returns The newly created `Plugin`.
11616
11804
  *
11617
11805
  * @deprecated
11618
11806
  */
11619
11807
  CreatePlugin(this: PluginManagerInterface): Instance | undefined;
11620
11808
  /**
11809
+ * Exports the entire place to an `.obj` file saved to a path chosen by the user in a file save dialog.
11810
+ *
11621
11811
  * - **ThreadSafety**: Unsafe
11622
11812
  *
11623
11813
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginManagerInterface#ExportPlace)
11624
- * @param this
11625
- * @param filePath
11814
+ * @param this The singleton object returned by the global `PluginManager()` function, exposing a small set of legacy Studio plugin utilities.
11815
+ * @param filePath Ignored. A file save dialog determines the export path.
11626
11816
  */
11627
11817
  ExportPlace(this: PluginManagerInterface, filePath?: string): void;
11628
11818
  /**
11819
+ * Exports the current `Selection` to an `.obj` file saved to a path chosen by the user in a file save dialog.
11820
+ *
11629
11821
  * - **ThreadSafety**: Unsafe
11630
11822
  *
11631
11823
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginManagerInterface#ExportSelection)
11632
- * @param this
11633
- * @param filePath
11824
+ * @param this The singleton object returned by the global `PluginManager()` function, exposing a small set of legacy Studio plugin utilities.
11825
+ * @param filePath Ignored. A file save dialog determines the export path.
11634
11826
  */
11635
11827
  ExportSelection(this: PluginManagerInterface, filePath?: string): void;
11636
11828
  }
@@ -11729,6 +11921,8 @@ interface PluginPolicyService extends Instance {
11729
11921
  readonly _nominal_PluginPolicyService: unique symbol;
11730
11922
  }
11731
11923
  /**
11924
+ * A toolbar created by `Plugin:CreateToolbar()` that groups `PluginToolbarButtons` in the Studio ribbon.
11925
+ *
11732
11926
  * - **Tags**: NotCreatable
11733
11927
  *
11734
11928
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginToolbar)
@@ -11748,7 +11942,7 @@ interface PluginToolbar extends Instance {
11748
11942
  * - **ThreadSafety**: Unsafe
11749
11943
  *
11750
11944
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginToolbar#CreateButton)
11751
- * @param this
11945
+ * @param this A toolbar created by `Plugin:CreateToolbar()` that groups `PluginToolbarButtons` in the Studio ribbon.
11752
11946
  * @param buttonId A unique button ID.
11753
11947
  * @param tooltip The text displayed in the tooltip shown when a user hovers over the button.
11754
11948
  * @param iconname The asset ID of the icon displayed in the button.
@@ -11758,6 +11952,8 @@ interface PluginToolbar extends Instance {
11758
11952
  CreateButton(this: PluginToolbar, buttonId: string, tooltip: string, iconname: string, text?: string): PluginToolbarButton;
11759
11953
  }
11760
11954
  /**
11955
+ * A button on a `PluginToolbar` in the Studio ribbon, created by `PluginToolbar:CreateButton()`, that fires `Click` when pressed.
11956
+ *
11761
11957
  * - **Tags**: NotCreatable
11762
11958
  *
11763
11959
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginToolbarButton)
@@ -11772,6 +11968,8 @@ interface PluginToolbarButton extends Instance {
11772
11968
  */
11773
11969
  readonly _nominal_PluginToolbarButton: unique symbol;
11774
11970
  /**
11971
+ * The content of the image used as the button's icon in the toolbar. Only supports asset URIs.
11972
+ *
11775
11973
  * - **ThreadSafety**: ReadSafe
11776
11974
  * - **Tags**: NotReplicated
11777
11975
  *
@@ -11784,8 +11982,8 @@ interface PluginToolbarButton extends Instance {
11784
11982
  * - **ThreadSafety**: Unsafe
11785
11983
  *
11786
11984
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginToolbarButton#SetActive)
11787
- * @param this
11788
- * @param active
11985
+ * @param this A button on a `PluginToolbar` in the Studio ribbon, created by `PluginToolbar:CreateButton()`, that fires `Click` when pressed.
11986
+ * @param active Whether to set the button to its active, pressed state (`true`) or its inactive state (`false`).
11789
11987
  */
11790
11988
  SetActive(this: PluginToolbarButton, active: boolean): void;
11791
11989
  /**
@@ -12014,6 +12212,8 @@ interface ProceduralBehaviorSchedulerService extends Instance {
12014
12212
  readonly _nominal_ProceduralBehaviorSchedulerService: unique symbol;
12015
12213
  }
12016
12214
  /**
12215
+ * An internal engine service that generates collision geometry (physics data) for `MeshPart` and `PartOperation` instances that need new physics.
12216
+ *
12017
12217
  * - **Tags**: NotCreatable, Service
12018
12218
  *
12019
12219
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProcessInstancePhysicsService)
@@ -12061,6 +12261,8 @@ interface ProximityPromptService extends Instance {
12061
12261
  readonly _nominal_ProximityPromptService: unique symbol;
12062
12262
  }
12063
12263
  /**
12264
+ * A service that centralizes uploading assets to Roblox, including publishing cage mesh edits and creating assets or asset versions.
12265
+ *
12064
12266
  * - **Tags**: NotCreatable, Service, NotReplicated
12065
12267
  *
12066
12268
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PublishService)
@@ -12136,6 +12338,8 @@ interface ReflectionService extends Instance {
12136
12338
  readonly _nominal_ReflectionService: unique symbol;
12137
12339
  }
12138
12340
  /**
12341
+ * Team Create service that executes Luau commands sent from a Studio client on the collaborative editing server and relays their output back to that client.
12342
+ *
12139
12343
  * - **Tags**: NotCreatable, Service
12140
12344
  *
12141
12345
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteCommandService)
@@ -12166,6 +12370,8 @@ interface RemoteCursorService extends Instance {
12166
12370
  readonly _nominal_RemoteCursorService: unique symbol;
12167
12371
  }
12168
12372
  /**
12373
+ * Studio service that runs the server side of Luau remote debugging over DAP; not created during normal script execution.
12374
+ *
12169
12375
  * - **Tags**: NotCreatable, Service, NotReplicated
12170
12376
  *
12171
12377
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteDebuggerServer)
@@ -12196,6 +12402,8 @@ interface RemoteFunction<T extends Callback = Callback> extends Instance {
12196
12402
  readonly _nominal_RemoteFunction: unique symbol;
12197
12403
  }
12198
12404
  /**
12405
+ * A singleton settings class that exposes rendering configuration for graphics quality, framerate management, and debug visualization in Roblox Studio.
12406
+ *
12199
12407
  * - **Tags**: NotCreatable, Service, NotReplicated, NotBrowsable
12200
12408
  *
12201
12409
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RenderSettings)
@@ -12243,6 +12451,8 @@ interface RenderSettings extends Instance {
12243
12451
  */
12244
12452
  EnableFRM: boolean;
12245
12453
  /**
12454
+ * Toggles whether virtual reality (VR) mode is enabled.
12455
+ *
12246
12456
  * - **ThreadSafety**: ReadSafe
12247
12457
  *
12248
12458
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RenderSettings#Enable VR Mode)
@@ -12321,6 +12531,8 @@ interface RenderSettings extends Instance {
12321
12531
  */
12322
12532
  ShowBoundingBoxes: boolean;
12323
12533
  /**
12534
+ * Studio only. Selects a debug rendering visualization overlay for the viewport.
12535
+ *
12324
12536
  * - **ThreadSafety**: ReadSafe
12325
12537
  *
12326
12538
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RenderSettings#ViewMode)
@@ -12332,13 +12544,12 @@ interface RenderSettings extends Instance {
12332
12544
  * - **ThreadSafety**: Unsafe
12333
12545
  *
12334
12546
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RenderSettings#GetMaxQualityLevel)
12335
- * @param this
12547
+ * @param this A singleton settings class that exposes rendering configuration for graphics quality, framerate management, and debug visualization in Roblox Studio.
12548
+ * @returns The total number of quality levels available in the rendering system.
12336
12549
  */
12337
12550
  GetMaxQualityLevel(this: RenderSettings): number;
12338
12551
  }
12339
12552
  /**
12340
- * An internal testing utility for the rendering pipeline.
12341
- *
12342
12553
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RenderingTest)
12343
12554
  */
12344
12555
  interface RenderingTest extends Instance {
@@ -12778,6 +12989,8 @@ interface ScriptCommitService extends Instance {
12778
12989
  readonly _nominal_ScriptCommitService: unique symbol;
12779
12990
  }
12780
12991
  /**
12992
+ * A service that manages the execution of all `BaseScript` objects.
12993
+ *
12781
12994
  * - **Tags**: NotCreatable, Service, NotReplicated
12782
12995
  *
12783
12996
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext)
@@ -12797,8 +13010,8 @@ interface ScriptContext extends Instance {
12797
13010
  * - **ThreadSafety**: Unsafe
12798
13011
  *
12799
13012
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#SetTimeout)
12800
- * @param this
12801
- * @param seconds
13013
+ * @param this A service that manages the execution of all `BaseScript` objects.
13014
+ * @param seconds The maximum time, in seconds, that a script may run between yields before the watchdog interrupts it. A value of `0` disables the timeout.
12802
13015
  */
12803
13016
  SetTimeout(this: ScriptContext, seconds: number): void;
12804
13017
  }
@@ -12986,6 +13199,8 @@ interface ScriptDebuggerService extends Instance {
12986
13199
  OnStopped: ((stopped: object) => object) | undefined;
12987
13200
  }
12988
13201
  /**
13202
+ * Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13203
+ *
12989
13204
  * - **Tags**: NotCreatable, NotReplicated
12990
13205
  *
12991
13206
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument)
@@ -13005,8 +13220,9 @@ interface ScriptDocument extends Instance {
13005
13220
  * - **ThreadSafety**: Unsafe
13006
13221
  *
13007
13222
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetLine)
13008
- * @param this
13009
- * @param lineIndex
13223
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13224
+ * @param lineIndex The 1-indexed line number to retrieve. Defaults to the current cursor line if not provided.
13225
+ * @returns The text content of the specified line as a string.
13010
13226
  */
13011
13227
  GetLine(this: ScriptDocument, lineIndex?: number): string;
13012
13228
  /**
@@ -13015,7 +13231,8 @@ interface ScriptDocument extends Instance {
13015
13231
  * - **ThreadSafety**: Unsafe
13016
13232
  *
13017
13233
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetLineCount)
13018
- * @param this
13234
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13235
+ * @returns The total number of lines in the document.
13019
13236
  */
13020
13237
  GetLineCount(this: ScriptDocument): number;
13021
13238
  /**
@@ -13024,7 +13241,8 @@ interface ScriptDocument extends Instance {
13024
13241
  * - **ThreadSafety**: Unsafe
13025
13242
  *
13026
13243
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetScript)
13027
- * @param this
13244
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13245
+ * @returns The `LuaSourceContainer` that the document is editing, or `nil` if the document does not represent a script instance in the place (e.g. the Command Bar is not a real script instance).
13028
13246
  */
13029
13247
  GetScript(this: ScriptDocument): LuaSourceContainer;
13030
13248
  /**
@@ -13033,7 +13251,8 @@ interface ScriptDocument extends Instance {
13033
13251
  * - **ThreadSafety**: Unsafe
13034
13252
  *
13035
13253
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetSelectedText)
13036
- * @param this
13254
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13255
+ * @returns The currently selected text as a string, or an empty string if nothing is selected.
13037
13256
  */
13038
13257
  GetSelectedText(this: ScriptDocument): string;
13039
13258
  /**
@@ -13042,7 +13261,7 @@ interface ScriptDocument extends Instance {
13042
13261
  * - **ThreadSafety**: Unsafe
13043
13262
  *
13044
13263
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetSelection)
13045
- * @param this
13264
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13046
13265
  * @returns CursorLine, CursorChar, AnchorLine, AnchorChar.
13047
13266
  */
13048
13267
  GetSelection(this: ScriptDocument): unknown;
@@ -13052,7 +13271,8 @@ interface ScriptDocument extends Instance {
13052
13271
  * - **ThreadSafety**: Unsafe
13053
13272
  *
13054
13273
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetSelectionEnd)
13055
- * @param this
13274
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13275
+ * @returns A tuple of (line, character) representing the larger of the cursor and anchor positions, both 1-indexed.
13056
13276
  */
13057
13277
  GetSelectionEnd(this: ScriptDocument): unknown;
13058
13278
  /**
@@ -13061,7 +13281,8 @@ interface ScriptDocument extends Instance {
13061
13281
  * - **ThreadSafety**: Unsafe
13062
13282
  *
13063
13283
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetSelectionStart)
13064
- * @param this
13284
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13285
+ * @returns A tuple of (line, character) representing the smaller of the cursor and anchor positions, both 1-indexed.
13065
13286
  */
13066
13287
  GetSelectionStart(this: ScriptDocument): unknown;
13067
13288
  /**
@@ -13070,11 +13291,12 @@ interface ScriptDocument extends Instance {
13070
13291
  * - **ThreadSafety**: Unsafe
13071
13292
  *
13072
13293
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetText)
13073
- * @param this
13074
- * @param startLine
13075
- * @param startCharacter
13076
- * @param endLine
13077
- * @param endCharacter
13294
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13295
+ * @param startLine The 1-indexed line number where the text range begins. Optional; omit all arguments to get the entire document.
13296
+ * @param startCharacter The 1-indexed UTF-8 byte offset within `startLine` where the text range begins.
13297
+ * @param endLine The 1-indexed line number where the text range ends (exclusive). Optional; omit to read from `startLine`/`startCharacter` to the end of the document.
13298
+ * @param endCharacter The 1-indexed UTF-8 byte offset within `endLine` where the text range ends (exclusive).
13299
+ * @returns The text content within the specified range as a string.
13078
13300
  */
13079
13301
  GetText(this: ScriptDocument, startLine?: number, startCharacter?: number, endLine?: number, endCharacter?: number): string;
13080
13302
  /**
@@ -13083,7 +13305,8 @@ interface ScriptDocument extends Instance {
13083
13305
  * - **ThreadSafety**: Unsafe
13084
13306
  *
13085
13307
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetViewport)
13086
- * @param this
13308
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13309
+ * @returns A tuple of (startLine, endLine) representing the 1-indexed range of lines currently visible in the editor.
13087
13310
  */
13088
13311
  GetViewport(this: ScriptDocument): unknown;
13089
13312
  /**
@@ -13092,7 +13315,8 @@ interface ScriptDocument extends Instance {
13092
13315
  * - **ThreadSafety**: Unsafe
13093
13316
  *
13094
13317
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#HasSelectedText)
13095
- * @param this
13318
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13319
+ * @returns `true` if the editor has a non-empty text selection, `false` otherwise.
13096
13320
  */
13097
13321
  HasSelectedText(this: ScriptDocument): boolean;
13098
13322
  /**
@@ -13101,7 +13325,8 @@ interface ScriptDocument extends Instance {
13101
13325
  * - **ThreadSafety**: Unsafe
13102
13326
  *
13103
13327
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#IsCommandBar)
13104
- * @param this
13328
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13329
+ * @returns `true` if this document represents the Command bar, `false` otherwise.
13105
13330
  */
13106
13331
  IsCommandBar(this: ScriptDocument): boolean;
13107
13332
  /**
@@ -13111,7 +13336,8 @@ interface ScriptDocument extends Instance {
13111
13336
  * - **Tags**: Yields
13112
13337
  *
13113
13338
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#CloseAsync)
13114
- * @param this
13339
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13340
+ * @returns A tuple where the first element is `true` if the editor closed successfully, or `false` followed by a string describing the failure reason.
13115
13341
  */
13116
13342
  CloseAsync(this: ScriptDocument): unknown;
13117
13343
  /**
@@ -13121,12 +13347,13 @@ interface ScriptDocument extends Instance {
13121
13347
  * - **Tags**: Yields
13122
13348
  *
13123
13349
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#EditTextAsync)
13124
- * @param this
13125
- * @param newText
13126
- * @param startLine
13127
- * @param startCharacter
13128
- * @param endLine
13129
- * @param endCharacter
13350
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13351
+ * @param newText The replacement string to insert into the specified range.
13352
+ * @param startLine The 1-indexed line number where the replacement range begins.
13353
+ * @param startCharacter The 1-indexed UTF-8 byte offset within `startLine` where the replacement range begins.
13354
+ * @param endLine The 1-indexed line number where the replacement range ends (exclusive).
13355
+ * @param endCharacter The 1-indexed UTF-8 byte offset within `endLine` where the replacement range ends (exclusive).
13356
+ * @returns A tuple where the first element is `true` if the edit was applied successfully, or `false` followed by a string describing the failure reason.
13130
13357
  */
13131
13358
  EditTextAsync(this: ScriptDocument, newText: string, startLine: number, startCharacter: number, endLine: number, endCharacter: number): unknown;
13132
13359
  /**
@@ -13136,20 +13363,24 @@ interface ScriptDocument extends Instance {
13136
13363
  * - **Tags**: Yields
13137
13364
  *
13138
13365
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#ForceSetSelectionAsync)
13139
- * @param this
13140
- * @param cursorLine
13141
- * @param cursorCharacter
13142
- * @param anchorLine
13143
- * @param anchorCharacter
13366
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13367
+ * @param cursorLine The 1-indexed line number for the cursor position.
13368
+ * @param cursorCharacter The 1-indexed UTF-8 byte offset within the line for the cursor position.
13369
+ * @param anchorLine The 1-indexed line number for the anchor position. Defaults to `cursorLine` if not provided.
13370
+ * @param anchorCharacter The 1-indexed UTF-8 byte offset within the line for the anchor position. Defaults to `cursorCharacter` if not provided.
13371
+ * @returns A tuple where the first element is `true` if the cursor was updated, or `false` followed by a string explaining why the update was declined.
13144
13372
  */
13145
13373
  ForceSetSelectionAsync(this: ScriptDocument, cursorLine: number, cursorCharacter: number, anchorLine?: number, anchorCharacter?: number): unknown;
13146
13374
  /**
13375
+ * Applies a batch of text edits to the document as a single atomic operation. Yields the current thread until the editor responds.
13376
+ *
13147
13377
  * - **ThreadSafety**: Unsafe
13148
13378
  * - **Tags**: Yields
13149
13379
  *
13150
13380
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#MultiEditTextAsync)
13151
- * @param this
13152
- * @param edits
13381
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13382
+ * @param edits An array of tables, each describing a text replacement with fields `NewText`, `StartLine`, `StartCharacter`, `EndLine`, and `EndCharacter`.
13383
+ * @returns A tuple where the first element is `true` if all edits were applied successfully, or `false` followed by a string describing the failure reason.
13153
13384
  */
13154
13385
  MultiEditTextAsync(this: ScriptDocument, edits: Array<unknown>): unknown;
13155
13386
  /**
@@ -13159,18 +13390,24 @@ interface ScriptDocument extends Instance {
13159
13390
  * - **Tags**: Yields
13160
13391
  *
13161
13392
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#RequestSetSelectionAsync)
13162
- * @param this
13163
- * @param cursorLine
13164
- * @param cursorCharacter
13165
- * @param anchorLine
13166
- * @param anchorCharacter
13393
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13394
+ * @param cursorLine The 1-indexed line number for the cursor position.
13395
+ * @param cursorCharacter The 1-indexed UTF-8 byte offset within the line for the cursor position.
13396
+ * @param anchorLine The 1-indexed line number for the anchor position. Defaults to `cursorLine` if not provided.
13397
+ * @param anchorCharacter The 1-indexed UTF-8 byte offset within the line for the anchor position. Defaults to `cursorCharacter` if not provided.
13398
+ * @returns A tuple where the first element is `true` if the cursor was updated, or `false` followed by a string explaining why the update was declined.
13167
13399
  */
13168
13400
  RequestSetSelectionAsync(this: ScriptDocument, cursorLine: number, cursorCharacter: number, anchorLine?: number, anchorCharacter?: number): unknown;
13169
13401
  /**
13402
+ * Applies a batch of line-based text edits that appear in the editor as reviewable inline diffs, allowing users to accept or reject each change.
13403
+ *
13170
13404
  * - **ThreadSafety**: Unsafe
13171
13405
  * - **Tags**: Yields
13172
13406
  *
13173
13407
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#ReviewableTextEditsAsync)
13408
+ * @param this Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
13409
+ * @param changes An array of tables, each with a `Text` field (the replacement string), a `StartLine` field (1-indexed line to insert or begin replacing at), and an optional `EndLine` field (1-indexed last line to replace, inclusive).
13410
+ * @returns A tuple where the first element is `true` if the edits were applied successfully, or `false` followed by a string describing the failure reason.
13174
13411
  */
13175
13412
  ReviewableTextEditsAsync(this: ScriptDocument, changes: Array<unknown>): unknown;
13176
13413
  /**
@@ -13213,7 +13450,7 @@ interface ScriptEditorService extends Instance {
13213
13450
  *
13214
13451
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#DeregisterAutocompleteCallback)
13215
13452
  * @param this This service is used for interacting with `ScriptDocument` instances.
13216
- * @param name
13453
+ * @param name The identifier that was used when registering the callback with `ScriptEditorService:RegisterAutocompleteCallback()`.
13217
13454
  */
13218
13455
  DeregisterAutocompleteCallback(this: ScriptEditorService, name: string): void;
13219
13456
  /**
@@ -13223,7 +13460,7 @@ interface ScriptEditorService extends Instance {
13223
13460
  *
13224
13461
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#DeregisterScriptAnalysisCallback)
13225
13462
  * @param this This service is used for interacting with `ScriptDocument` instances.
13226
- * @param name
13463
+ * @param name The identifier that was used when registering the callback with `ScriptEditorService:RegisterScriptAnalysisCallback()`.
13227
13464
  */
13228
13465
  DeregisterScriptAnalysisCallback(this: ScriptEditorService, name: string): void;
13229
13466
  /**
@@ -13233,7 +13470,8 @@ interface ScriptEditorService extends Instance {
13233
13470
  *
13234
13471
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#FindScriptDocument)
13235
13472
  * @param this This service is used for interacting with `ScriptDocument` instances.
13236
- * @param script
13473
+ * @param script The `LuaSourceContainer` (such as a `Script`, `LocalScript`, or `ModuleScript`) to find the open document for.
13474
+ * @returns The open `ScriptDocument` corresponding to the given script, or nil if the script is not currently open in the Script Editor.
13237
13475
  */
13238
13476
  FindScriptDocument(this: ScriptEditorService, script: LuaSourceContainer): ScriptDocument;
13239
13477
  /**
@@ -13243,7 +13481,8 @@ interface ScriptEditorService extends Instance {
13243
13481
  *
13244
13482
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#GetEditorSource)
13245
13483
  * @param this This service is used for interacting with `ScriptDocument` instances.
13246
- * @param script
13484
+ * @param script The `LuaSourceContainer` to retrieve the edit-time source text for.
13485
+ * @returns The edit-time source text of the script as a string.
13247
13486
  */
13248
13487
  GetEditorSource(this: ScriptEditorService, script: LuaSourceContainer): string;
13249
13488
  /**
@@ -13253,6 +13492,7 @@ interface ScriptEditorService extends Instance {
13253
13492
  *
13254
13493
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#GetScriptDocuments)
13255
13494
  * @param this This service is used for interacting with `ScriptDocument` instances.
13495
+ * @returns An array of `ScriptDocument` objects representing all currently open editor tabs, including the command bar.
13256
13496
  */
13257
13497
  GetScriptDocuments(this: ScriptEditorService): Array<Instance>;
13258
13498
  /**
@@ -13262,9 +13502,9 @@ interface ScriptEditorService extends Instance {
13262
13502
  *
13263
13503
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#RegisterAutocompleteCallback)
13264
13504
  * @param this This service is used for interacting with `ScriptDocument` instances.
13265
- * @param name
13266
- * @param priority
13267
- * @param callbackFunction
13505
+ * @param name A unique identifier for this callback, used to deregister it later with `ScriptEditorService:DeregisterAutocompleteCallback()`.
13506
+ * @param priority The invocation order among registered callbacks; lower values run first.
13507
+ * @param callbackFunction The function invoked during autocomplete with the signature `(Request: table, Response: table) -> table`.
13268
13508
  */
13269
13509
  RegisterAutocompleteCallback(this: ScriptEditorService, name: string, priority: number, callbackFunction: Callback): void;
13270
13510
  /**
@@ -13274,9 +13514,9 @@ interface ScriptEditorService extends Instance {
13274
13514
  *
13275
13515
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#RegisterScriptAnalysisCallback)
13276
13516
  * @param this This service is used for interacting with `ScriptDocument` instances.
13277
- * @param name
13278
- * @param priority
13279
- * @param callbackFunction
13517
+ * @param name A unique identifier for this callback, used to deregister it later with `ScriptEditorService:DeregisterScriptAnalysisCallback()`.
13518
+ * @param priority The invocation order among registered callbacks; lower values run first.
13519
+ * @param callbackFunction The function invoked during Script Analysis with the signature `(Request: table) -> table`, returning a response containing diagnostics.
13280
13520
  */
13281
13521
  RegisterScriptAnalysisCallback(this: ScriptEditorService, name: string, priority: number, callbackFunction: Callback): void;
13282
13522
  /**
@@ -13287,9 +13527,12 @@ interface ScriptEditorService extends Instance {
13287
13527
  *
13288
13528
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#OpenScriptDocumentAsync)
13289
13529
  * @param this This service is used for interacting with `ScriptDocument` instances.
13290
- * @param script
13530
+ * @param script The `LuaSourceContainer` to open in the Script Editor.
13291
13531
  * @param options A dictionary that supports the following options: - `Temporary` — Boolean. Whether to open the script in a preview tab. Default is false.
13292
13532
  * - `HighlightRange` — A nested dictionary containing a line and character range to highlight in the editor. Example: `HighlightRange = { Start = { Line = 10, Character = 1 }, End = { Line = 15, Character = 20 }}`.
13533
+ *
13534
+ *
13535
+ * @returns A tuple where the first value is a boolean indicating success and the second is nil on success or a string describing the problem on failure.
13293
13536
  */
13294
13537
  OpenScriptDocumentAsync(this: ScriptEditorService, script: LuaSourceContainer, options?: object): unknown;
13295
13538
  /**
@@ -13330,6 +13573,8 @@ interface ScriptEditorService extends Instance {
13330
13573
  readonly TextDocumentDidOpen: RBXScriptSignal<(newDocument: ScriptDocument) => void>;
13331
13574
  }
13332
13575
  /**
13576
+ * A service that captures sampling-based profiles of Luau script execution on the server or on a client.
13577
+ *
13333
13578
  * - **Tags**: NotCreatable, Service
13334
13579
  *
13335
13580
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService)
@@ -13344,62 +13589,79 @@ interface ScriptProfilerService extends Instance {
13344
13589
  */
13345
13590
  readonly _nominal_ScriptProfilerService: unique symbol;
13346
13591
  /**
13592
+ * Requests the current script profiling data from the specified player's client.
13593
+ *
13347
13594
  * - **ThreadSafety**: Unsafe
13348
13595
  *
13349
13596
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ClientRequestData)
13350
- * @param this
13351
- * @param player
13597
+ * @param this A service that captures sampling-based profiles of Luau script execution on the server or on a client.
13598
+ * @param player The `Player` whose client should report its profiling data. When called on a client, this must be the local player.
13352
13599
  */
13353
13600
  ClientRequestData(this: ScriptProfilerService, player: Player): void;
13354
13601
  /**
13602
+ * Begins Luau script profiling for the specified player's client.
13603
+ *
13355
13604
  * - **ThreadSafety**: Unsafe
13356
13605
  *
13357
13606
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ClientStart)
13358
- * @param this
13359
- * @param player
13360
- * @param frequency
13607
+ * @param this A service that captures sampling-based profiles of Luau script execution on the server or on a client.
13608
+ * @param player The `Player` whose client should start profiling. When called on a client, this must be the local player.
13609
+ * @param frequency Optional sampling frequency in samples per second. Defaults to `1000` and must be within the range `[1, 10000]`.
13361
13610
  */
13362
13611
  ClientStart(this: ScriptProfilerService, player: Player, frequency?: number): void;
13363
13612
  /**
13613
+ * Stops Luau script profiling for the specified player's client.
13614
+ *
13364
13615
  * - **ThreadSafety**: Unsafe
13365
13616
  *
13366
13617
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ClientStop)
13367
- * @param this
13368
- * @param player
13618
+ * @param this A service that captures sampling-based profiles of Luau script execution on the server or on a client.
13619
+ * @param player The `Player` whose client should stop profiling. When called on a client, this must be the local player.
13369
13620
  */
13370
13621
  ClientStop(this: ScriptProfilerService, player: Player): void;
13371
13622
  /**
13623
+ * Parses a script-profiling JSON string into a structured Luau table.
13624
+ *
13372
13625
  * - **ThreadSafety**: Unsafe
13373
13626
  * - **Tags**: CustomLuaState
13374
13627
  *
13375
13628
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#DeserializeJSON)
13376
- * @param this
13377
- * @param jsonString
13629
+ * @param this A service that captures sampling-based profiles of Luau script execution on the server or on a client.
13630
+ * @param jsonString The profiling data encoded as a JSON string, such as the value delivered by `OnNewData`.
13631
+ * @returns A dictionary representing the parsed profiling data, including the session's categories, call nodes, and function metadata.
13378
13632
  */
13379
13633
  DeserializeJSON(this: ScriptProfilerService, jsonString?: string): object;
13380
13634
  /**
13635
+ * Requests the current script profiling data from the server.
13636
+ *
13381
13637
  * - **ThreadSafety**: Unsafe
13382
13638
  *
13383
13639
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ServerRequestData)
13384
- * @param this
13640
+ * @param this A service that captures sampling-based profiles of Luau script execution on the server or on a client.
13385
13641
  */
13386
13642
  ServerRequestData(this: ScriptProfilerService): void;
13387
13643
  /**
13644
+ * Begins Luau script profiling on the server.
13645
+ *
13388
13646
  * - **ThreadSafety**: Unsafe
13389
13647
  *
13390
13648
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ServerStart)
13391
- * @param this
13392
- * @param frequency
13649
+ * @param this A service that captures sampling-based profiles of Luau script execution on the server or on a client.
13650
+ * @param frequency Optional sampling frequency in samples per second. Defaults to `1000` and must be within the range `[1, 10000]`.
13393
13651
  */
13394
13652
  ServerStart(this: ScriptProfilerService, frequency?: number): void;
13395
13653
  /**
13654
+ * Stops Luau script profiling on the server.
13655
+ *
13396
13656
  * - **ThreadSafety**: Unsafe
13397
13657
  *
13398
13658
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ServerStop)
13399
- * @param this
13659
+ * @param this A service that captures sampling-based profiles of Luau script execution on the server or on a client.
13400
13660
  */
13401
13661
  ServerStop(this: ScriptProfilerService): void;
13402
13662
  /**
13663
+ * Fires when a new profiling data snapshot becomes available after a data request.
13664
+ *
13403
13665
  * - **ThreadSafety**: Unsafe
13404
13666
  *
13405
13667
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#OnNewData)
@@ -13436,6 +13698,21 @@ interface ScriptRuntime extends Instance {
13436
13698
  */
13437
13699
  readonly _nominal_ScriptRuntime: unique symbol;
13438
13700
  }
13701
+ /**
13702
+ * - **Tags**: NotCreatable, Service
13703
+ *
13704
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptScannerService)
13705
+ */
13706
+ interface ScriptScannerService extends Instance {
13707
+ /**
13708
+ * **DO NOT USE!**
13709
+ *
13710
+ * This field exists to force TypeScript to recognize this as a nominal type
13711
+ * @hidden
13712
+ * @deprecated
13713
+ */
13714
+ readonly _nominal_ScriptScannerService: unique symbol;
13715
+ }
13439
13716
  /**
13440
13717
  * The Selection service controls the `Instances` that are selected in Roblox Studio.
13441
13718
  *
@@ -13494,6 +13771,8 @@ interface Selection extends Instance {
13494
13771
  Set(this: Selection, selection: Array<Instance>): void;
13495
13772
  }
13496
13773
  /**
13774
+ * Studio service that draws selection outline highlights for the local user's selection and for Team Create collaborators' selections.
13775
+ *
13497
13776
  * - **Tags**: NotCreatable, Service
13498
13777
  *
13499
13778
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelectionHighlightManager)
@@ -13556,6 +13835,8 @@ interface BuoyancySensor extends SensorBase {
13556
13835
  readonly _nominal_BuoyancySensor: unique symbol;
13557
13836
  }
13558
13837
  /**
13838
+ * An abstract base class for `SensorBase` types that supply sensory data to a character controller.
13839
+ *
13559
13840
  * - **Tags**: NotCreatable
13560
13841
  *
13561
13842
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerSensor)
@@ -15645,16 +15926,20 @@ interface StudioDeviceSimulatorService extends Instance {
15645
15926
  */
15646
15927
  readonly _nominal_StudioDeviceSimulatorService: unique symbol;
15647
15928
  /**
15929
+ * Creates a custom device preset and returns its ID.
15930
+ *
15648
15931
  * - **ThreadSafety**: Unsafe
15649
15932
  * - **Tags**: Yields
15650
15933
  *
15651
15934
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#CreateDeviceAsync)
15652
15935
  * @param this Service allowing you to control Studio's Device Simulator.
15653
- * @param config
15936
+ * @param config A dictionary describing the new device. Required fields: `Name` (string, 1-200 characters, cannot be `"default"`), `Width` (int, 1-7680 pixels), `Height` (int, 1-4320 pixels), `PixelDensity` (int, 72-10000 DPI). Optional fields: `DeviceForm` (`DeviceForm`, default Phone), `ResolutionScale` (float, default 1.0, max 10.0), `PortraitKeyboardHeight` (int, default 0), `LandscapeKeyboardHeight` (int, default 0).
15654
15937
  * @returns string
15655
15938
  */
15656
15939
  CreateDeviceAsync(this: StudioDeviceSimulatorService, config: object): string;
15657
15940
  /**
15941
+ * Returns the ID of the currently active device, or `"default"` if none is active.
15942
+ *
15658
15943
  * - **ThreadSafety**: Unsafe
15659
15944
  * - **Tags**: Yields
15660
15945
  *
@@ -15664,16 +15949,20 @@ interface StudioDeviceSimulatorService extends Instance {
15664
15949
  */
15665
15950
  GetDeviceAsync(this: StudioDeviceSimulatorService): string;
15666
15951
  /**
15952
+ * Returns the configuration dictionary for the specified device.
15953
+ *
15667
15954
  * - **ThreadSafety**: Unsafe
15668
15955
  * - **Tags**: Yields
15669
15956
  *
15670
15957
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetDeviceInfoAsync)
15671
15958
  * @param this Service allowing you to control Studio's Device Simulator.
15672
- * @param deviceId
15959
+ * @param deviceId The unique identifier of the device to query. Must be a valid ID from `GetDeviceListAsync()`; cannot be `"default"`.
15673
15960
  * @returns A dictionary containing the device configuration and passed to `CreateDeviceAsync` and `UpdateDeviceAsync`.
15674
15961
  */
15675
15962
  GetDeviceInfoAsync(this: StudioDeviceSimulatorService, deviceId: string): object;
15676
15963
  /**
15964
+ * Returns an array of all available device IDs.
15965
+ *
15677
15966
  * - **ThreadSafety**: Unsafe
15678
15967
  * - **Tags**: Yields
15679
15968
  *
@@ -15683,6 +15972,8 @@ interface StudioDeviceSimulatorService extends Instance {
15683
15972
  */
15684
15973
  GetDeviceListAsync(this: StudioDeviceSimulatorService): Array<unknown>;
15685
15974
  /**
15975
+ * Returns the current simulated screen orientation.
15976
+ *
15686
15977
  * - **ThreadSafety**: Unsafe
15687
15978
  * - **Tags**: Yields
15688
15979
  *
@@ -15692,6 +15983,8 @@ interface StudioDeviceSimulatorService extends Instance {
15692
15983
  */
15693
15984
  GetOrientationAsync(this: StudioDeviceSimulatorService): Enum.ScreenOrientation;
15694
15985
  /**
15986
+ * Returns the current simulated pixel density in DPI.
15987
+ *
15695
15988
  * - **ThreadSafety**: Unsafe
15696
15989
  * - **Tags**: Yields
15697
15990
  *
@@ -15701,6 +15994,8 @@ interface StudioDeviceSimulatorService extends Instance {
15701
15994
  */
15702
15995
  GetPixelDensityAsync(this: StudioDeviceSimulatorService): number;
15703
15996
  /**
15997
+ * Returns the current simulated viewport resolution.
15998
+ *
15704
15999
  * - **ThreadSafety**: Unsafe
15705
16000
  * - **Tags**: Yields
15706
16001
  *
@@ -15710,70 +16005,86 @@ interface StudioDeviceSimulatorService extends Instance {
15710
16005
  */
15711
16006
  GetResolutionAsync(this: StudioDeviceSimulatorService): Vector2;
15712
16007
  /**
16008
+ * Returns how the simulated resolution currently maps to the Studio viewport.
16009
+ *
15713
16010
  * - **ThreadSafety**: Unsafe
15714
16011
  * - **Tags**: Yields
15715
16012
  *
15716
16013
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetScalingModeAsync)
15717
16014
  * @param this Service allowing you to control Studio's Device Simulator.
15718
- * @returns DeviceSimulatorScalingMode
16015
+ * @returns The current `DeviceSimulatorScalingMode`.
15719
16016
  */
15720
16017
  GetScalingModeAsync(this: StudioDeviceSimulatorService): Enum.DeviceSimulatorScalingMode;
15721
16018
  /**
16019
+ * Removes a custom device from the catalog.
16020
+ *
15722
16021
  * - **ThreadSafety**: Unsafe
15723
16022
  * - **Tags**: Yields
15724
16023
  *
15725
16024
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#RemoveDeviceAsync)
15726
16025
  * @param this Service allowing you to control Studio's Device Simulator.
15727
- * @param deviceId
16026
+ * @param deviceId The unique identifier of the custom device to remove.
15728
16027
  */
15729
16028
  RemoveDeviceAsync(this: StudioDeviceSimulatorService, deviceId: string): void;
15730
16029
  /**
16030
+ * Activates the specified device or stops simulation if `"default"` is passed.
16031
+ *
15731
16032
  * - **ThreadSafety**: Unsafe
15732
16033
  * - **Tags**: Yields
15733
16034
  *
15734
16035
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetDeviceAsync)
15735
16036
  * @param this Service allowing you to control Studio's Device Simulator.
15736
- * @param deviceId
16037
+ * @param deviceId The unique identifier of the device to activate, or `"default"` to stop simulation.
15737
16038
  */
15738
16039
  SetDeviceAsync(this: StudioDeviceSimulatorService, deviceId: string): void;
15739
16040
  /**
16041
+ * Sets the simulated screen orientation.
16042
+ *
15740
16043
  * - **ThreadSafety**: Unsafe
15741
16044
  * - **Tags**: Yields
15742
16045
  *
15743
16046
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetOrientationAsync)
15744
16047
  * @param this Service allowing you to control Studio's Device Simulator.
15745
- * @param orientation
16048
+ * @param orientation The target screen orientation. Accepted values are `ScreenOrientation.Portrait`, `ScreenOrientation.LandscapeLeft`, or `ScreenOrientation.LandscapeRight`.
15746
16049
  */
15747
16050
  SetOrientationAsync(this: StudioDeviceSimulatorService, orientation: CastsToEnum<Enum.ScreenOrientation>): void;
15748
16051
  /**
16052
+ * Overrides the simulated pixel density in DPI for the current session.
16053
+ *
15749
16054
  * - **ThreadSafety**: Unsafe
15750
16055
  * - **Tags**: Yields
15751
16056
  *
15752
16057
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetPixelDensityAsync)
15753
16058
  * @param this Service allowing you to control Studio's Device Simulator.
15754
- * @param density
16059
+ * @param density The pixel density override in DPI. Must be between 72 and 10000.
15755
16060
  */
15756
16061
  SetPixelDensityAsync(this: StudioDeviceSimulatorService, density: number): void;
15757
16062
  /**
16063
+ * Overrides the simulated viewport resolution for the current session.
16064
+ *
15758
16065
  * - **ThreadSafety**: Unsafe
15759
16066
  * - **Tags**: Yields
15760
16067
  *
15761
16068
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetResolutionAsync)
15762
16069
  * @param this Service allowing you to control Studio's Device Simulator.
15763
- * @param width
15764
- * @param height
16070
+ * @param width The viewport width in pixels (horizontal axis in landscape orientation). Range: 1 to 7680.
16071
+ * @param height The viewport height in pixels (vertical axis in landscape orientation). Range: 1 to 4320.
15765
16072
  */
15766
16073
  SetResolutionAsync(this: StudioDeviceSimulatorService, width: number, height: number): void;
15767
16074
  /**
16075
+ * Sets how the simulated resolution maps to the Studio viewport.
16076
+ *
15768
16077
  * - **ThreadSafety**: Unsafe
15769
16078
  * - **Tags**: Yields
15770
16079
  *
15771
16080
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetScalingModeAsync)
15772
16081
  * @param this Service allowing you to control Studio's Device Simulator.
15773
- * @param mode
16082
+ * @param mode The scaling mode to apply. One of `DeviceSimulatorScalingMode.ScaleToPhysicalSize`, `DeviceSimulatorScalingMode.ActualResolution`, or `DeviceSimulatorScalingMode.FitToWindow`.
15774
16083
  */
15775
16084
  SetScalingModeAsync(this: StudioDeviceSimulatorService, mode: CastsToEnum<Enum.DeviceSimulatorScalingMode>): void;
15776
16085
  /**
16086
+ * Stops the active device simulation.
16087
+ *
15777
16088
  * - **ThreadSafety**: Unsafe
15778
16089
  * - **Tags**: Yields
15779
16090
  *
@@ -15782,16 +16093,20 @@ interface StudioDeviceSimulatorService extends Instance {
15782
16093
  */
15783
16094
  StopSimulationAsync(this: StudioDeviceSimulatorService): void;
15784
16095
  /**
16096
+ * Updates the configuration of an existing custom device.
16097
+ *
15785
16098
  * - **ThreadSafety**: Unsafe
15786
16099
  * - **Tags**: Yields
15787
16100
  *
15788
16101
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#UpdateDeviceAsync)
15789
16102
  * @param this Service allowing you to control Studio's Device Simulator.
15790
- * @param deviceId
15791
- * @param config
16103
+ * @param deviceId The unique identifier of the custom device to update.
16104
+ * @param config A dictionary of device fields to apply. Uses patch semantics: omitted optional fields retain their current values. Same schema as `CreateDeviceAsync()`.
15792
16105
  */
15793
16106
  UpdateDeviceAsync(this: StudioDeviceSimulatorService, deviceId: string, config: object): void;
15794
16107
  /**
16108
+ * Fires when the active simulation state changes.
16109
+ *
15795
16110
  * - **ThreadSafety**: Unsafe
15796
16111
  *
15797
16112
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#ConfigurationChanged)
@@ -16292,6 +16607,8 @@ interface SurfaceAppearance extends Instance {
16292
16607
  */
16293
16608
  ColorMap: ContentId;
16294
16609
  /**
16610
+ * `Content` object that determines the color and opacity of the surface.
16611
+ *
16295
16612
  * - **ThreadSafety**: ReadSafe
16296
16613
  * - **Tags**: Hidden
16297
16614
  *
@@ -16315,6 +16632,8 @@ interface SurfaceAppearance extends Instance {
16315
16632
  */
16316
16633
  MetalnessMap: ContentId;
16317
16634
  /**
16635
+ * `Content` object that determines which parts of the surface are metal or non-metal.
16636
+ *
16318
16637
  * - **ThreadSafety**: ReadSafe
16319
16638
  * - **Tags**: Hidden
16320
16639
  *
@@ -16330,6 +16649,8 @@ interface SurfaceAppearance extends Instance {
16330
16649
  */
16331
16650
  NormalMap: ContentId;
16332
16651
  /**
16652
+ * `Content` object that modifies the lighting of the surface by adding bumps, dents, cracks, and curves.
16653
+ *
16333
16654
  * - **ThreadSafety**: ReadSafe
16334
16655
  * - **Tags**: Hidden
16335
16656
  *
@@ -16345,6 +16666,8 @@ interface SurfaceAppearance extends Instance {
16345
16666
  */
16346
16667
  RoughnessMap: ContentId;
16347
16668
  /**
16669
+ * `Content` object that determines the apparent roughness across the surface.
16670
+ *
16348
16671
  * - **ThreadSafety**: ReadSafe
16349
16672
  * - **Tags**: Hidden
16350
16673
  *
@@ -16949,6 +17272,8 @@ interface TextChatService extends Instance {
16949
17272
  set CreateDefaultTextChannels(value: boolean);
16950
17273
  }
16951
17274
  /**
17275
+ * Represents the result of a call to `TextService:FilterStringAsync()`, used to distribute a filtered string accordingly.
17276
+ *
16952
17277
  * - **Tags**: NotCreatable, NotReplicated
16953
17278
  *
16954
17279
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextFilterResult)
@@ -16964,6 +17289,8 @@ interface TextFilterResult extends Instance {
16964
17289
  readonly _nominal_TextFilterResult: unique symbol;
16965
17290
  }
16966
17291
  /**
17292
+ * Holds the filtered source text and its filtered translations produced by `TextService:FilterAndTranslateStringAsync()`.
17293
+ *
16967
17294
  * - **Tags**: NotCreatable, NotReplicated
16968
17295
  *
16969
17296
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextFilterTranslatedResult)
@@ -17511,6 +17838,8 @@ interface UIListLayout extends UIGridStyleLayout {
17511
17838
  readonly _nominal_UIListLayout: unique symbol;
17512
17839
  }
17513
17840
  /**
17841
+ * Positions sibling UI elements as full-size pages in a single row or column that users can scroll or animate through one page at a time.
17842
+ *
17514
17843
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIPageLayout)
17515
17844
  */
17516
17845
  interface UIPageLayout extends UIGridStyleLayout {
@@ -17614,6 +17943,8 @@ interface UIDragDetectorService extends Instance {
17614
17943
  readonly _nominal_UIDragDetectorService: unique symbol;
17615
17944
  }
17616
17945
  /**
17946
+ * Team Create service that maps `UniqueId` to and from RFC-4122 strings; not for experience scripts.
17947
+ *
17617
17948
  * - **Tags**: NotCreatable, Service
17618
17949
  *
17619
17950
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UniqueIdLookupService)
@@ -17983,6 +18314,8 @@ interface VersionControlService extends Instance {
17983
18314
  readonly _nominal_VersionControlService: unique symbol;
17984
18315
  }
17985
18316
  /**
18317
+ * Service that manages camera capture for features such as avatar facial-animation tracking. Requires `RobloxScript` security; not callable from experience scripts.
18318
+ *
17986
18319
  * - **Tags**: NotCreatable, Service
17987
18320
  *
17988
18321
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoCaptureService)
@@ -18291,6 +18624,21 @@ interface WrapTextureTransfer extends Instance {
18291
18624
  */
18292
18625
  readonly _nominal_WrapTextureTransfer: unique symbol;
18293
18626
  }
18627
+ /**
18628
+ * - **Tags**: NotCreatable, NotReplicated
18629
+ *
18630
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Logger)
18631
+ */
18632
+ interface Logger extends RBXObject {
18633
+ /**
18634
+ * **DO NOT USE!**
18635
+ *
18636
+ * This field exists to force TypeScript to recognize this as a nominal type
18637
+ * @hidden
18638
+ * @deprecated
18639
+ */
18640
+ readonly _nominal_Logger: unique symbol;
18641
+ }
18294
18642
  /**
18295
18643
  * - **Tags**: NotCreatable
18296
18644
  *