@rbxts/types 1.0.943 → 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.
- package/include/generated/None.d.ts +1136 -341
- package/include/generated/PluginSecurity.d.ts +453 -155
- package/include/generated/enums.d.ts +1809 -83
- package/package.json +1 -1
|
@@ -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;
|
|
@@ -487,6 +490,7 @@ interface CreatableInstances {
|
|
|
487
490
|
PitchShiftSoundEffect: PitchShiftSoundEffect;
|
|
488
491
|
Plane: Plane;
|
|
489
492
|
PlaneConstraint: PlaneConstraint;
|
|
493
|
+
PlayerControlState: PlayerControlState;
|
|
490
494
|
PluginAction: PluginAction;
|
|
491
495
|
PluginCapabilities: PluginCapabilities;
|
|
492
496
|
PointLight: PointLight;
|
|
@@ -1110,6 +1114,8 @@ interface Accessory extends Accoutrement {
|
|
|
1110
1114
|
/**
|
|
1111
1115
|
* **Deprecated:** This class has been superseded by the `Accessory` class. Do not use it for new work.
|
|
1112
1116
|
*
|
|
1117
|
+
* A deprecated accessory container superseded by `Accessory`.
|
|
1118
|
+
*
|
|
1113
1119
|
* - **Tags**:
|
|
1114
1120
|
*
|
|
1115
1121
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Hat)
|
|
@@ -1584,6 +1590,8 @@ interface AssetCounterService extends Instance {
|
|
|
1584
1590
|
readonly _nominal_AssetCounterService: unique symbol;
|
|
1585
1591
|
}
|
|
1586
1592
|
/**
|
|
1593
|
+
* Runs a local HTTP server that serves assets to real devices.
|
|
1594
|
+
*
|
|
1587
1595
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
1588
1596
|
*
|
|
1589
1597
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetDeliveryProxy)
|
|
@@ -1629,6 +1637,8 @@ interface AssetManagerService extends Instance {
|
|
|
1629
1637
|
readonly _nominal_AssetManagerService: unique symbol;
|
|
1630
1638
|
}
|
|
1631
1639
|
/**
|
|
1640
|
+
* Configures a single patch asset built by `IncrementalPatchBuilder` and served through `AssetDeliveryProxy`.
|
|
1641
|
+
*
|
|
1632
1642
|
* - **Tags**: NotCreatable, NotReplicated
|
|
1633
1643
|
*
|
|
1634
1644
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetPatchSettings)
|
|
@@ -2640,6 +2650,8 @@ interface StarterGui extends BasePlayerGui {
|
|
|
2640
2650
|
ProcessUserInput: boolean;
|
|
2641
2651
|
}
|
|
2642
2652
|
/**
|
|
2653
|
+
* Abstract base class inherited by `RemoteEvent` and `UnreliableRemoteEvent` for asynchronous, one-way communication across the client-server boundary.
|
|
2654
|
+
*
|
|
2643
2655
|
* - **Tags**: NotCreatable
|
|
2644
2656
|
*
|
|
2645
2657
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseRemoteEvent)
|
|
@@ -2685,6 +2697,8 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
|
|
|
2685
2697
|
readonly _nominal_UnreliableRemoteEvent: unique symbol;
|
|
2686
2698
|
}
|
|
2687
2699
|
/**
|
|
2700
|
+
* Abstract base class for `WrapTarget` and `WrapLayer` that stores cage mesh data for layered clothing deformation.
|
|
2701
|
+
*
|
|
2688
2702
|
* - **Tags**: NotCreatable
|
|
2689
2703
|
*
|
|
2690
2704
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseWrap)
|
|
@@ -2699,6 +2713,8 @@ interface BaseWrap extends Instance {
|
|
|
2699
2713
|
*/
|
|
2700
2714
|
readonly _nominal_BaseWrap: unique symbol;
|
|
2701
2715
|
/**
|
|
2716
|
+
* The cage mesh this wrap uses to deform geometry, stored as a `Content` value.
|
|
2717
|
+
*
|
|
2702
2718
|
* - **ThreadSafety**: ReadSafe
|
|
2703
2719
|
*
|
|
2704
2720
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseWrap#CageMeshContent)
|
|
@@ -2767,6 +2783,8 @@ interface WrapLayer extends BaseWrap {
|
|
|
2767
2783
|
*/
|
|
2768
2784
|
set BindOffset(value: CFrame);
|
|
2769
2785
|
/**
|
|
2786
|
+
* The reference mesh that defines the Inner Cage of the `WrapLayer`, stored as a `Content` value.
|
|
2787
|
+
*
|
|
2770
2788
|
* - **ThreadSafety**: ReadSafe
|
|
2771
2789
|
*
|
|
2772
2790
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ReferenceMeshContent)
|
|
@@ -3058,6 +3076,21 @@ interface BodyPartDescription extends Instance {
|
|
|
3058
3076
|
*/
|
|
3059
3077
|
readonly _nominal_BodyPartDescription: unique symbol;
|
|
3060
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
|
+
}
|
|
3061
3094
|
/**
|
|
3062
3095
|
* - **Tags**: NotReplicated
|
|
3063
3096
|
*
|
|
@@ -3121,6 +3154,8 @@ interface CacheableContentProvider extends Instance {
|
|
|
3121
3154
|
readonly _nominal_CacheableContentProvider: unique symbol;
|
|
3122
3155
|
}
|
|
3123
3156
|
/**
|
|
3157
|
+
* A service that fetches and caches SLIM (Scalable Lightweight Interactive Models) asset content representations for model rendering.
|
|
3158
|
+
*
|
|
3124
3159
|
* - **Tags**: NotCreatable, Service
|
|
3125
3160
|
*
|
|
3126
3161
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimContentProvider)
|
|
@@ -3196,33 +3231,38 @@ interface ChangeHistoryService extends Instance {
|
|
|
3196
3231
|
*/
|
|
3197
3232
|
FinishRecording(this: ChangeHistoryService, identifier: string, operation: CastsToEnum<Enum.FinishRecordingOperation>, finalOptions?: object): void;
|
|
3198
3233
|
/**
|
|
3199
|
-
* Returns whether there
|
|
3234
|
+
* Returns whether there is an action available to redo and, if so, the name of that action.
|
|
3200
3235
|
*
|
|
3201
3236
|
* - **ThreadSafety**: Unsafe
|
|
3202
3237
|
*
|
|
3203
3238
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#GetCanRedo)
|
|
3204
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`.
|
|
3205
3241
|
*/
|
|
3206
3242
|
GetCanRedo(this: ChangeHistoryService): unknown;
|
|
3207
3243
|
/**
|
|
3208
|
-
* Returns whether there
|
|
3244
|
+
* Returns whether there is an action available to undo and, if so, the name of that action.
|
|
3209
3245
|
*
|
|
3210
3246
|
* - **ThreadSafety**: Unsafe
|
|
3211
3247
|
*
|
|
3212
3248
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#GetCanUndo)
|
|
3213
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`.
|
|
3214
3251
|
*/
|
|
3215
3252
|
GetCanUndo(this: ChangeHistoryService): unknown;
|
|
3216
3253
|
/**
|
|
3254
|
+
* Returns whether the plugin currently has a recording in progress, optionally checking for a specific recording identifier.
|
|
3255
|
+
*
|
|
3217
3256
|
* - **ThreadSafety**: Unsafe
|
|
3218
3257
|
*
|
|
3219
3258
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#IsRecordingInProgress)
|
|
3220
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.
|
|
3221
|
-
* @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`.
|
|
3222
3262
|
*/
|
|
3223
3263
|
IsRecordingInProgress(this: ChangeHistoryService, identifier?: string): boolean;
|
|
3224
3264
|
/**
|
|
3225
|
-
*
|
|
3265
|
+
* Re-executes the most recently undone action, advancing forward through the undo/redo history.
|
|
3226
3266
|
*
|
|
3227
3267
|
* - **ThreadSafety**: Unsafe
|
|
3228
3268
|
*
|
|
@@ -3231,7 +3271,7 @@ interface ChangeHistoryService extends Instance {
|
|
|
3231
3271
|
*/
|
|
3232
3272
|
Redo(this: ChangeHistoryService): void;
|
|
3233
3273
|
/**
|
|
3234
|
-
* Clears the history
|
|
3274
|
+
* Clears the undo/redo history by collapsing it into a single base waypoint.
|
|
3235
3275
|
*
|
|
3236
3276
|
* - **ThreadSafety**: Unsafe
|
|
3237
3277
|
*
|
|
@@ -3246,7 +3286,7 @@ interface ChangeHistoryService extends Instance {
|
|
|
3246
3286
|
*
|
|
3247
3287
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#SetEnabled)
|
|
3248
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.
|
|
3249
|
-
* @param state
|
|
3289
|
+
* @param state Whether to enable (`true`) or disable (`false`) the service.
|
|
3250
3290
|
*/
|
|
3251
3291
|
SetEnabled(this: ChangeHistoryService, state: boolean): void;
|
|
3252
3292
|
/**
|
|
@@ -3256,7 +3296,7 @@ interface ChangeHistoryService extends Instance {
|
|
|
3256
3296
|
*
|
|
3257
3297
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#SetWaypoint)
|
|
3258
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.
|
|
3259
|
-
* @param name
|
|
3299
|
+
* @param name The name to assign to the new waypoint, which appears in the undo/redo history.
|
|
3260
3300
|
*/
|
|
3261
3301
|
SetWaypoint(this: ChangeHistoryService, name: string): void;
|
|
3262
3302
|
/**
|
|
@@ -3268,10 +3308,11 @@ interface ChangeHistoryService extends Instance {
|
|
|
3268
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.
|
|
3269
3309
|
* @param name Name of the action being performed suitable for logging and coding purposes.
|
|
3270
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.
|
|
3271
3312
|
*/
|
|
3272
3313
|
TryBeginRecording(this: ChangeHistoryService, name: string, displayName?: string): string | undefined;
|
|
3273
3314
|
/**
|
|
3274
|
-
*
|
|
3315
|
+
* Reverts the most recent action, stepping backward through the undo/redo history.
|
|
3275
3316
|
*
|
|
3276
3317
|
* - **ThreadSafety**: Unsafe
|
|
3277
3318
|
*
|
|
@@ -3296,7 +3337,7 @@ interface ChangeHistoryService extends Instance {
|
|
|
3296
3337
|
*/
|
|
3297
3338
|
readonly OnRecordingStarted: RBXScriptSignal<(name: string, displayName?: string) => void>;
|
|
3298
3339
|
/**
|
|
3299
|
-
*
|
|
3340
|
+
* Fires after an action is redone, reporting the name of the action that was replayed.
|
|
3300
3341
|
*
|
|
3301
3342
|
* - **ThreadSafety**: Unsafe
|
|
3302
3343
|
*
|
|
@@ -3304,7 +3345,7 @@ interface ChangeHistoryService extends Instance {
|
|
|
3304
3345
|
*/
|
|
3305
3346
|
readonly OnRedo: RBXScriptSignal<(waypoint: string) => void>;
|
|
3306
3347
|
/**
|
|
3307
|
-
*
|
|
3348
|
+
* Fires after an action is undone, reporting the name of the action that was reverted.
|
|
3308
3349
|
*
|
|
3309
3350
|
* - **ThreadSafety**: Unsafe
|
|
3310
3351
|
*
|
|
@@ -3655,6 +3696,8 @@ interface Configuration extends Instance {
|
|
|
3655
3696
|
readonly _nominal_Configuration: unique symbol;
|
|
3656
3697
|
}
|
|
3657
3698
|
/**
|
|
3699
|
+
* Configures a server's `DataModel` for a place session during game-server startup.
|
|
3700
|
+
*
|
|
3658
3701
|
* - **Tags**: NotCreatable, Service
|
|
3659
3702
|
*
|
|
3660
3703
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigureServerService)
|
|
@@ -4115,6 +4158,8 @@ interface VehicleController extends Controller {
|
|
|
4115
4158
|
readonly _nominal_VehicleController: unique symbol;
|
|
4116
4159
|
}
|
|
4117
4160
|
/**
|
|
4161
|
+
* Abstract base class for the controllers that a `ControllerManager` uses to move its character.
|
|
4162
|
+
*
|
|
4118
4163
|
* - **Tags**: NotCreatable
|
|
4119
4164
|
*
|
|
4120
4165
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerBase)
|
|
@@ -4130,6 +4175,8 @@ interface ControllerBase extends Instance {
|
|
|
4130
4175
|
readonly _nominal_ControllerBase: unique symbol;
|
|
4131
4176
|
}
|
|
4132
4177
|
/**
|
|
4178
|
+
* A physics character controller that governs movement while a character is airborne.
|
|
4179
|
+
*
|
|
4133
4180
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AirController)
|
|
4134
4181
|
*/
|
|
4135
4182
|
interface AirController extends ControllerBase {
|
|
@@ -4143,6 +4190,8 @@ interface AirController extends ControllerBase {
|
|
|
4143
4190
|
readonly _nominal_AirController: unique symbol;
|
|
4144
4191
|
}
|
|
4145
4192
|
/**
|
|
4193
|
+
* A physics character controller that moves its `ControllerManager.RootPart` along a climbable surface, such as a ladder.
|
|
4194
|
+
*
|
|
4146
4195
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ClimbController)
|
|
4147
4196
|
*/
|
|
4148
4197
|
interface ClimbController extends ControllerBase {
|
|
@@ -4156,6 +4205,8 @@ interface ClimbController extends ControllerBase {
|
|
|
4156
4205
|
readonly _nominal_ClimbController: unique symbol;
|
|
4157
4206
|
}
|
|
4158
4207
|
/**
|
|
4208
|
+
* The `ControllerBase` that moves a `ControllerManager` character while it is walking or standing on the ground.
|
|
4209
|
+
*
|
|
4159
4210
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GroundController)
|
|
4160
4211
|
*/
|
|
4161
4212
|
interface GroundController extends ControllerBase {
|
|
@@ -4169,6 +4220,8 @@ interface GroundController extends ControllerBase {
|
|
|
4169
4220
|
readonly _nominal_GroundController: unique symbol;
|
|
4170
4221
|
}
|
|
4171
4222
|
/**
|
|
4223
|
+
* The `ControllerBase` that moves a `ControllerManager` character while it is swimming.
|
|
4224
|
+
*
|
|
4172
4225
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SwimController)
|
|
4173
4226
|
*/
|
|
4174
4227
|
interface SwimController extends ControllerBase {
|
|
@@ -4259,6 +4312,8 @@ interface CreationDBService extends Instance {
|
|
|
4259
4312
|
readonly _nominal_CreationDBService: unique symbol;
|
|
4260
4313
|
}
|
|
4261
4314
|
/**
|
|
4315
|
+
* Provides methods for querying Creator Store product information and purchasing assets.
|
|
4316
|
+
*
|
|
4262
4317
|
* - **Tags**: NotCreatable, Service
|
|
4263
4318
|
*
|
|
4264
4319
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CreatorStoreService)
|
|
@@ -4289,6 +4344,8 @@ interface CrossDMScriptChangeListener extends Instance {
|
|
|
4289
4344
|
readonly _nominal_CrossDMScriptChangeListener: unique symbol;
|
|
4290
4345
|
}
|
|
4291
4346
|
/**
|
|
4347
|
+
* Internal-only instance that writes text to a file in the engine's logs directory.
|
|
4348
|
+
*
|
|
4292
4349
|
* - **Tags**: NotReplicated
|
|
4293
4350
|
*
|
|
4294
4351
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CustomLog)
|
|
@@ -4438,6 +4495,8 @@ interface DataModelSession extends Instance {
|
|
|
4438
4495
|
readonly _nominal_DataModelSession: unique symbol;
|
|
4439
4496
|
}
|
|
4440
4497
|
/**
|
|
4498
|
+
* Specifies additional parameters for a `GlobalDataStore:GetAsync()` call.
|
|
4499
|
+
*
|
|
4441
4500
|
* - **Tags**: NotReplicated
|
|
4442
4501
|
*
|
|
4443
4502
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreGetOptions)
|
|
@@ -4975,6 +5034,8 @@ interface Dragger extends Instance {
|
|
|
4975
5034
|
readonly _nominal_Dragger: unique symbol;
|
|
4976
5035
|
}
|
|
4977
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
|
+
*
|
|
4978
5039
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
4979
5040
|
*
|
|
4980
5041
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService)
|
|
@@ -6243,6 +6304,8 @@ interface GlobalDataStore extends Instance {
|
|
|
6243
6304
|
readonly _nominal_GlobalDataStore: unique symbol;
|
|
6244
6305
|
}
|
|
6245
6306
|
/**
|
|
6307
|
+
* A `GlobalDataStore` that also supports versioning, key metadata, and enumerating keys.
|
|
6308
|
+
*
|
|
6246
6309
|
* - **Tags**: NotCreatable, NotReplicated
|
|
6247
6310
|
*
|
|
6248
6311
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStore)
|
|
@@ -6660,6 +6723,8 @@ interface BillboardGui extends LayerCollector {
|
|
|
6660
6723
|
readonly _nominal_BillboardGui: unique symbol;
|
|
6661
6724
|
}
|
|
6662
6725
|
/**
|
|
6726
|
+
* An abstract base class for GUIs that display `GuiObjects` in Roblox Studio widgets.
|
|
6727
|
+
*
|
|
6663
6728
|
* - **Tags**: NotCreatable, NotReplicated
|
|
6664
6729
|
*
|
|
6665
6730
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginGui)
|
|
@@ -6679,7 +6744,7 @@ interface PluginGui extends LayerCollector {
|
|
|
6679
6744
|
* - **ThreadSafety**: Unsafe
|
|
6680
6745
|
*
|
|
6681
6746
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginGui#GetRelativeMousePosition)
|
|
6682
|
-
* @param this
|
|
6747
|
+
* @param this An abstract base class for GUIs that display `GuiObjects` in Roblox Studio widgets.
|
|
6683
6748
|
* @returns The screen position of the mouse relative to the PluginGui in pixels.
|
|
6684
6749
|
*/
|
|
6685
6750
|
GetRelativeMousePosition(this: PluginGui): Vector2;
|
|
@@ -6733,6 +6798,8 @@ interface PluginGui extends LayerCollector {
|
|
|
6733
6798
|
readonly WindowFocused: RBXScriptSignal<() => void>;
|
|
6734
6799
|
}
|
|
6735
6800
|
/**
|
|
6801
|
+
* A `PluginGui` that displays its contents in a dockable, resizable Roblox Studio window.
|
|
6802
|
+
*
|
|
6736
6803
|
* - **Tags**: NotCreatable, NotReplicated
|
|
6737
6804
|
*
|
|
6738
6805
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DockWidgetPluginGui)
|
|
@@ -6778,6 +6845,8 @@ interface ScreenGui extends LayerCollector {
|
|
|
6778
6845
|
readonly _nominal_ScreenGui: unique symbol;
|
|
6779
6846
|
}
|
|
6780
6847
|
/**
|
|
6848
|
+
* Base class for containers that render `GuiObjects` onto a face of a `BasePart` in the 3D world.
|
|
6849
|
+
*
|
|
6781
6850
|
* - **Tags**: NotCreatable
|
|
6782
6851
|
*
|
|
6783
6852
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceGuiBase)
|
|
@@ -7239,6 +7308,8 @@ interface GuiService extends Instance {
|
|
|
7239
7308
|
readonly _nominal_GuiService: unique symbol;
|
|
7240
7309
|
}
|
|
7241
7310
|
/**
|
|
7311
|
+
* An object that provides waveform-based haptic feedback (vibrations and rumbles) on supported controllers and mobile devices.
|
|
7312
|
+
*
|
|
7242
7313
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect)
|
|
7243
7314
|
*/
|
|
7244
7315
|
interface HapticEffect extends Instance {
|
|
@@ -7284,7 +7355,7 @@ interface HarmonyService extends Instance {
|
|
|
7284
7355
|
readonly _nominal_HarmonyService: unique symbol;
|
|
7285
7356
|
}
|
|
7286
7357
|
/**
|
|
7287
|
-
*
|
|
7358
|
+
* Generates and retrieves Luau heap memory profiles from the client and server Luau virtual machines for memory debugging.
|
|
7288
7359
|
*
|
|
7289
7360
|
* - **Tags**: NotCreatable, Service
|
|
7290
7361
|
*
|
|
@@ -7300,27 +7371,31 @@ interface HeapProfilerService extends Instance {
|
|
|
7300
7371
|
*/
|
|
7301
7372
|
readonly _nominal_HeapProfilerService: unique symbol;
|
|
7302
7373
|
/**
|
|
7303
|
-
*
|
|
7374
|
+
* Yields until the Luau heap profile of the specified player's client is available, then returns it as a JSON string.
|
|
7304
7375
|
*
|
|
7305
7376
|
* - **ThreadSafety**: Unsafe
|
|
7306
7377
|
* - **Tags**: Yields
|
|
7307
7378
|
*
|
|
7308
7379
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HeapProfilerService#ClientRequestDataAsync)
|
|
7309
|
-
* @param this
|
|
7310
|
-
* @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.
|
|
7311
7383
|
*/
|
|
7312
7384
|
ClientRequestDataAsync(this: HeapProfilerService, player: Player): string;
|
|
7313
7385
|
/**
|
|
7314
|
-
*
|
|
7386
|
+
* Yields until the server's Luau heap profile is available, then returns it as a JSON string.
|
|
7315
7387
|
*
|
|
7316
7388
|
* - **ThreadSafety**: Unsafe
|
|
7317
7389
|
* - **Tags**: Yields
|
|
7318
7390
|
*
|
|
7319
7391
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HeapProfilerService#ServerRequestDataAsync)
|
|
7320
|
-
* @param this
|
|
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.
|
|
7321
7394
|
*/
|
|
7322
7395
|
ServerRequestDataAsync(this: HeapProfilerService): string;
|
|
7323
7396
|
/**
|
|
7397
|
+
* Fires on the requesting machine with the compressed Luau heap profile produced for an earlier request.
|
|
7398
|
+
*
|
|
7324
7399
|
* - **ThreadSafety**: Unsafe
|
|
7325
7400
|
*
|
|
7326
7401
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HeapProfilerService#OnNewData)
|
|
@@ -7373,6 +7448,8 @@ interface HeightmapImporterService extends Instance {
|
|
|
7373
7448
|
readonly _nominal_HeightmapImporterService: unique symbol;
|
|
7374
7449
|
}
|
|
7375
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
|
+
*
|
|
7376
7453
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HiddenSurfaceRemovalAsset)
|
|
7377
7454
|
*/
|
|
7378
7455
|
interface HiddenSurfaceRemovalAsset extends Instance {
|
|
@@ -7491,6 +7568,8 @@ interface IKControl extends Instance {
|
|
|
7491
7568
|
readonly _nominal_IKControl: unique symbol;
|
|
7492
7569
|
}
|
|
7493
7570
|
/**
|
|
7571
|
+
* Internal Studio-only base interface for a Studio bridge service. Declares no scriptable members.
|
|
7572
|
+
*
|
|
7494
7573
|
* - **Tags**: NotCreatable, Service
|
|
7495
7574
|
*
|
|
7496
7575
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ILegacyStudioBridge)
|
|
@@ -7581,6 +7660,8 @@ interface AssetImportSession extends ImportSession {
|
|
|
7581
7660
|
readonly _nominal_AssetImportSession: unique symbol;
|
|
7582
7661
|
}
|
|
7583
7662
|
/**
|
|
7663
|
+
* Builds signed incremental patches for hot-reloading a running client from script changes detected by a separate file watcher.
|
|
7664
|
+
*
|
|
7584
7665
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
7585
7666
|
*
|
|
7586
7667
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder)
|
|
@@ -7746,6 +7827,21 @@ interface InstanceFileSyncService extends Instance {
|
|
|
7746
7827
|
*/
|
|
7747
7828
|
readonly StatusChanged: RBXScriptSignal<(instance: Instance, status: Enum.InstanceFileSyncStatus) => void>;
|
|
7748
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
|
+
}
|
|
7749
7845
|
/**
|
|
7750
7846
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
7751
7847
|
*
|
|
@@ -7862,6 +7958,8 @@ interface RotateP extends DynamicRotate {
|
|
|
7862
7958
|
/**
|
|
7863
7959
|
* **Deprecated:** This class works alongside the deprecated `SurfaceType` and should not be used for future work; use `HingeConstraint` instead.
|
|
7864
7960
|
*
|
|
7961
|
+
* Joins two parts and allows rotation driven by angular velocity from the Motor surface type.
|
|
7962
|
+
*
|
|
7865
7963
|
* - **Tags**:
|
|
7866
7964
|
*
|
|
7867
7965
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RotateV)
|
|
@@ -8033,6 +8131,8 @@ interface Snap extends JointInstance {
|
|
|
8033
8131
|
readonly _nominal_Snap: unique symbol;
|
|
8034
8132
|
}
|
|
8035
8133
|
/**
|
|
8134
|
+
* A `Motor`-like `JointInstance` that forms its connection using a `MotorFeature` and a `Hole`.
|
|
8135
|
+
*
|
|
8036
8136
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VelocityMotor)
|
|
8037
8137
|
*/
|
|
8038
8138
|
interface VelocityMotor extends JointInstance {
|
|
@@ -8046,6 +8146,8 @@ interface VelocityMotor extends JointInstance {
|
|
|
8046
8146
|
readonly _nominal_VelocityMotor: unique symbol;
|
|
8047
8147
|
}
|
|
8048
8148
|
/**
|
|
8149
|
+
* Holds two `BaseParts` together in a fixed relative position, regardless of whether they're touching.
|
|
8150
|
+
*
|
|
8049
8151
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Weld)
|
|
8050
8152
|
*/
|
|
8051
8153
|
interface Weld extends JointInstance {
|
|
@@ -9118,11 +9220,13 @@ interface NetworkPeer extends Instance {
|
|
|
9118
9220
|
*
|
|
9119
9221
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/NetworkPeer#SetOutgoingKBPSLimit)
|
|
9120
9222
|
* @param this The `NetworkPeer` object is the most basic class of the network objects.
|
|
9121
|
-
* @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.
|
|
9122
9224
|
*/
|
|
9123
9225
|
SetOutgoingKBPSLimit(this: NetworkPeer, limit: number): void;
|
|
9124
9226
|
}
|
|
9125
9227
|
/**
|
|
9228
|
+
* A service that manages a network connection's properties server.
|
|
9229
|
+
*
|
|
9126
9230
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
9127
9231
|
*
|
|
9128
9232
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/NetworkClient)
|
|
@@ -9138,6 +9242,8 @@ interface NetworkClient extends NetworkPeer {
|
|
|
9138
9242
|
readonly _nominal_NetworkClient: unique symbol;
|
|
9139
9243
|
}
|
|
9140
9244
|
/**
|
|
9245
|
+
* A server-side service that manages all `NetworkReplicator` instances and handles incoming client connections.
|
|
9246
|
+
*
|
|
9141
9247
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
9142
9248
|
*
|
|
9143
9249
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/NetworkServer)
|
|
@@ -9170,6 +9276,8 @@ interface NetworkReplicator extends Instance {
|
|
|
9170
9276
|
readonly _nominal_NetworkReplicator: unique symbol;
|
|
9171
9277
|
}
|
|
9172
9278
|
/**
|
|
9279
|
+
* The client-side `NetworkReplicator` that manages replication of data model changes between the server and itself.
|
|
9280
|
+
*
|
|
9173
9281
|
* - **Tags**: NotCreatable, NotReplicated
|
|
9174
9282
|
*
|
|
9175
9283
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ClientReplicator)
|
|
@@ -9185,6 +9293,8 @@ interface ClientReplicator extends NetworkReplicator {
|
|
|
9185
9293
|
readonly _nominal_ClientReplicator: unique symbol;
|
|
9186
9294
|
}
|
|
9187
9295
|
/**
|
|
9296
|
+
* The server-side `NetworkReplicator` that manages replication of data model changes between the server to a single connected client.
|
|
9297
|
+
*
|
|
9188
9298
|
* - **Tags**: NotCreatable, NotReplicated
|
|
9189
9299
|
*
|
|
9190
9300
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ServerReplicator)
|
|
@@ -10039,6 +10149,8 @@ interface PackageLink extends Instance {
|
|
|
10039
10149
|
readonly _nominal_PackageLink: unique symbol;
|
|
10040
10150
|
}
|
|
10041
10151
|
/**
|
|
10152
|
+
* Manages Roblox Studio packages, tracking their metadata and versions and handling updates to package contents.
|
|
10153
|
+
*
|
|
10042
10154
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
10043
10155
|
*
|
|
10044
10156
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PackageService)
|
|
@@ -10152,6 +10264,8 @@ interface CapturesPages extends Pages {
|
|
|
10152
10264
|
readonly _nominal_CapturesPages: unique symbol;
|
|
10153
10265
|
}
|
|
10154
10266
|
/**
|
|
10267
|
+
* A special version of `Pages` that stores the results of an Avatar Editor catalog search.
|
|
10268
|
+
*
|
|
10155
10269
|
* - **Tags**: NotCreatable, NotReplicated
|
|
10156
10270
|
*
|
|
10157
10271
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CatalogPages)
|
|
@@ -10261,6 +10375,8 @@ interface FriendPages extends Pages<{
|
|
|
10261
10375
|
readonly _nominal_FriendPages: unique symbol;
|
|
10262
10376
|
}
|
|
10263
10377
|
/**
|
|
10378
|
+
* A special version of `Pages` that contains information about a specific category of a user's inventory.
|
|
10379
|
+
*
|
|
10264
10380
|
* - **Tags**: NotCreatable, NotReplicated
|
|
10265
10381
|
*
|
|
10266
10382
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InventoryPages)
|
|
@@ -10331,6 +10447,8 @@ interface RecommendationPages extends Pages {
|
|
|
10331
10447
|
readonly _nominal_RecommendationPages: unique symbol;
|
|
10332
10448
|
}
|
|
10333
10449
|
/**
|
|
10450
|
+
* A generic Pages object that can contain variable data depending on the method that returned it.
|
|
10451
|
+
*
|
|
10334
10452
|
* - **Tags**: NotCreatable, NotReplicated
|
|
10335
10453
|
*
|
|
10336
10454
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StandardPages)
|
|
@@ -10543,6 +10661,8 @@ interface PerformanceControlService extends Instance {
|
|
|
10543
10661
|
readonly _nominal_PerformanceControlService: unique symbol;
|
|
10544
10662
|
}
|
|
10545
10663
|
/**
|
|
10664
|
+
* Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
10665
|
+
*
|
|
10546
10666
|
* - **Tags**: NotCreatable, Service
|
|
10547
10667
|
*
|
|
10548
10668
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService)
|
|
@@ -10932,6 +11052,21 @@ interface Player extends Instance {
|
|
|
10932
11052
|
SetSuperSafeChat(this: Player, value: boolean): void;
|
|
10933
11053
|
readonly Name: string;
|
|
10934
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
|
+
}
|
|
10935
11070
|
/**
|
|
10936
11071
|
* - **Tags**: NotCreatable, NotReplicated
|
|
10937
11072
|
*
|
|
@@ -11089,6 +11224,8 @@ interface Players extends Instance {
|
|
|
11089
11224
|
TeamChat(this: Players, message: string): void;
|
|
11090
11225
|
}
|
|
11091
11226
|
/**
|
|
11227
|
+
* The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11228
|
+
*
|
|
11092
11229
|
* - **Tags**: NotCreatable
|
|
11093
11230
|
*
|
|
11094
11231
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin)
|
|
@@ -11108,7 +11245,7 @@ interface Plugin extends Instance {
|
|
|
11108
11245
|
* - **ThreadSafety**: Unsafe
|
|
11109
11246
|
*
|
|
11110
11247
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Activate)
|
|
11111
|
-
* @param this
|
|
11248
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11112
11249
|
* @param exclusiveMouse A boolean specifying whether to activate the plugin with exclusive mouse. If `true`, a `PluginMouse` can be retrieved via `GetMouse()`.
|
|
11113
11250
|
*/
|
|
11114
11251
|
Activate(this: Plugin, exclusiveMouse: boolean): void;
|
|
@@ -11118,7 +11255,7 @@ interface Plugin extends Instance {
|
|
|
11118
11255
|
* - **ThreadSafety**: Unsafe
|
|
11119
11256
|
*
|
|
11120
11257
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreatePluginAction)
|
|
11121
|
-
* @param this
|
|
11258
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11122
11259
|
* @param actionId Must be a unique string that identifies this PluginAction from others.
|
|
11123
11260
|
* @param text The displayed name of the action.
|
|
11124
11261
|
* @param statusTip The displayed description of the action.
|
|
@@ -11132,7 +11269,7 @@ interface Plugin extends Instance {
|
|
|
11132
11269
|
* - **ThreadSafety**: Unsafe
|
|
11133
11270
|
*
|
|
11134
11271
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreatePluginMenu)
|
|
11135
|
-
* @param this
|
|
11272
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11136
11273
|
* @param id Unique ID for the menu.
|
|
11137
11274
|
* @param title The text to be displayed when used as a submenu.
|
|
11138
11275
|
* @param icon The icon to be displayed when used as a submenu.
|
|
@@ -11144,7 +11281,7 @@ interface Plugin extends Instance {
|
|
|
11144
11281
|
* - **ThreadSafety**: Unsafe
|
|
11145
11282
|
*
|
|
11146
11283
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreateToolbar)
|
|
11147
|
-
* @param this
|
|
11284
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11148
11285
|
* @param name The visible text on the toolbar, labeling the group of buttons contained within.
|
|
11149
11286
|
*/
|
|
11150
11287
|
CreateToolbar(this: Plugin, name: string): PluginToolbar;
|
|
@@ -11154,7 +11291,7 @@ interface Plugin extends Instance {
|
|
|
11154
11291
|
* - **ThreadSafety**: Unsafe
|
|
11155
11292
|
*
|
|
11156
11293
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Deactivate)
|
|
11157
|
-
* @param this
|
|
11294
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11158
11295
|
*/
|
|
11159
11296
|
Deactivate(this: Plugin): void;
|
|
11160
11297
|
/**
|
|
@@ -11163,7 +11300,7 @@ interface Plugin extends Instance {
|
|
|
11163
11300
|
* - **ThreadSafety**: Unsafe
|
|
11164
11301
|
*
|
|
11165
11302
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#GetJoinMode)
|
|
11166
|
-
* @param this
|
|
11303
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11167
11304
|
*/
|
|
11168
11305
|
GetJoinMode(this: Plugin): Enum.JointCreationMode;
|
|
11169
11306
|
/**
|
|
@@ -11172,7 +11309,7 @@ interface Plugin extends Instance {
|
|
|
11172
11309
|
* - **ThreadSafety**: Unsafe
|
|
11173
11310
|
*
|
|
11174
11311
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#GetMouse)
|
|
11175
|
-
* @param this
|
|
11312
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11176
11313
|
*/
|
|
11177
11314
|
GetMouse(this: Plugin): PluginMouse;
|
|
11178
11315
|
/**
|
|
@@ -11181,7 +11318,7 @@ interface Plugin extends Instance {
|
|
|
11181
11318
|
* - **ThreadSafety**: Unsafe
|
|
11182
11319
|
*
|
|
11183
11320
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#GetSelectedRibbonTool)
|
|
11184
|
-
* @param this
|
|
11321
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11185
11322
|
*/
|
|
11186
11323
|
GetSelectedRibbonTool(this: Plugin): Enum.RibbonTool;
|
|
11187
11324
|
/**
|
|
@@ -11190,8 +11327,8 @@ interface Plugin extends Instance {
|
|
|
11190
11327
|
* - **ThreadSafety**: Unsafe
|
|
11191
11328
|
*
|
|
11192
11329
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#GetSetting)
|
|
11193
|
-
* @param this
|
|
11194
|
-
* @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()`.
|
|
11195
11332
|
*/
|
|
11196
11333
|
GetSetting(this: Plugin, key: string): unknown;
|
|
11197
11334
|
/**
|
|
@@ -11203,7 +11340,7 @@ interface Plugin extends Instance {
|
|
|
11203
11340
|
* - **Tags**:
|
|
11204
11341
|
*
|
|
11205
11342
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#GetStudioUserId)
|
|
11206
|
-
* @param this
|
|
11343
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11207
11344
|
*
|
|
11208
11345
|
* @deprecated
|
|
11209
11346
|
*/
|
|
@@ -11214,8 +11351,8 @@ interface Plugin extends Instance {
|
|
|
11214
11351
|
* - **ThreadSafety**: Unsafe
|
|
11215
11352
|
*
|
|
11216
11353
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Intersect)
|
|
11217
|
-
* @param this
|
|
11218
|
-
* @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.
|
|
11219
11356
|
*/
|
|
11220
11357
|
Intersect(this: Plugin, objects: Array<Instance>): Instance | undefined;
|
|
11221
11358
|
/**
|
|
@@ -11224,7 +11361,7 @@ interface Plugin extends Instance {
|
|
|
11224
11361
|
* - **ThreadSafety**: Unsafe
|
|
11225
11362
|
*
|
|
11226
11363
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#IsActivated)
|
|
11227
|
-
* @param this
|
|
11364
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11228
11365
|
* @returns A boolean indicating whether the plugin is currently active.
|
|
11229
11366
|
*/
|
|
11230
11367
|
IsActivated(this: Plugin): boolean;
|
|
@@ -11234,7 +11371,7 @@ interface Plugin extends Instance {
|
|
|
11234
11371
|
* - **ThreadSafety**: Unsafe
|
|
11235
11372
|
*
|
|
11236
11373
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#IsActivatedWithExclusiveMouse)
|
|
11237
|
-
* @param this
|
|
11374
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11238
11375
|
* @returns Whether this plugin is currently active with an exclusive mouse.
|
|
11239
11376
|
*/
|
|
11240
11377
|
IsActivatedWithExclusiveMouse(this: Plugin): boolean;
|
|
@@ -11244,8 +11381,8 @@ interface Plugin extends Instance {
|
|
|
11244
11381
|
* - **ThreadSafety**: Unsafe
|
|
11245
11382
|
*
|
|
11246
11383
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Negate)
|
|
11247
|
-
* @param this
|
|
11248
|
-
* @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.
|
|
11249
11386
|
*/
|
|
11250
11387
|
Negate(this: Plugin, objects: Array<Instance>): Array<Instance>;
|
|
11251
11388
|
/**
|
|
@@ -11257,9 +11394,9 @@ interface Plugin extends Instance {
|
|
|
11257
11394
|
* - **Tags**:
|
|
11258
11395
|
*
|
|
11259
11396
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#OpenScript)
|
|
11260
|
-
* @param this
|
|
11261
|
-
* @param script
|
|
11262
|
-
* @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`.
|
|
11263
11400
|
*
|
|
11264
11401
|
* @deprecated
|
|
11265
11402
|
*/
|
|
@@ -11270,8 +11407,8 @@ interface Plugin extends Instance {
|
|
|
11270
11407
|
* - **ThreadSafety**: Unsafe
|
|
11271
11408
|
*
|
|
11272
11409
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#OpenWikiPage)
|
|
11273
|
-
* @param this
|
|
11274
|
-
* @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.
|
|
11275
11412
|
*/
|
|
11276
11413
|
OpenWikiPage(this: Plugin, url: string): void;
|
|
11277
11414
|
/**
|
|
@@ -11280,7 +11417,7 @@ interface Plugin extends Instance {
|
|
|
11280
11417
|
* - **ThreadSafety**: Unsafe
|
|
11281
11418
|
*
|
|
11282
11419
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#SaveSelectedToRoblox)
|
|
11283
|
-
* @param this
|
|
11420
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11284
11421
|
*/
|
|
11285
11422
|
SaveSelectedToRoblox(this: Plugin): void;
|
|
11286
11423
|
/**
|
|
@@ -11289,9 +11426,9 @@ interface Plugin extends Instance {
|
|
|
11289
11426
|
* - **ThreadSafety**: Unsafe
|
|
11290
11427
|
*
|
|
11291
11428
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#SelectRibbonTool)
|
|
11292
|
-
* @param this
|
|
11293
|
-
* @param tool
|
|
11294
|
-
* @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.
|
|
11295
11432
|
*/
|
|
11296
11433
|
SelectRibbonTool(this: Plugin, tool: CastsToEnum<Enum.RibbonTool>, position: UDim2): void;
|
|
11297
11434
|
/**
|
|
@@ -11300,8 +11437,8 @@ interface Plugin extends Instance {
|
|
|
11300
11437
|
* - **ThreadSafety**: Unsafe
|
|
11301
11438
|
*
|
|
11302
11439
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Separate)
|
|
11303
|
-
* @param this
|
|
11304
|
-
* @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.
|
|
11305
11442
|
*/
|
|
11306
11443
|
Separate(this: Plugin, objects: Array<Instance>): Array<Instance>;
|
|
11307
11444
|
/**
|
|
@@ -11310,9 +11447,9 @@ interface Plugin extends Instance {
|
|
|
11310
11447
|
* - **ThreadSafety**: Unsafe
|
|
11311
11448
|
*
|
|
11312
11449
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#SetSetting)
|
|
11313
|
-
* @param this
|
|
11314
|
-
* @param key
|
|
11315
|
-
* @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`).
|
|
11316
11453
|
*/
|
|
11317
11454
|
SetSetting(this: Plugin, key: string, value: unknown): void;
|
|
11318
11455
|
/**
|
|
@@ -11321,8 +11458,8 @@ interface Plugin extends Instance {
|
|
|
11321
11458
|
* - **ThreadSafety**: Unsafe
|
|
11322
11459
|
*
|
|
11323
11460
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#StartDrag)
|
|
11324
|
-
* @param this
|
|
11325
|
-
* @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`.
|
|
11326
11463
|
*/
|
|
11327
11464
|
StartDrag(this: Plugin, dragData: object): void;
|
|
11328
11465
|
/**
|
|
@@ -11331,8 +11468,8 @@ interface Plugin extends Instance {
|
|
|
11331
11468
|
* - **ThreadSafety**: Unsafe
|
|
11332
11469
|
*
|
|
11333
11470
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Union)
|
|
11334
|
-
* @param this
|
|
11335
|
-
* @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.
|
|
11336
11473
|
*/
|
|
11337
11474
|
Union(this: Plugin, objects: Array<BasePart>): UnionOperation;
|
|
11338
11475
|
/**
|
|
@@ -11344,7 +11481,7 @@ interface Plugin extends Instance {
|
|
|
11344
11481
|
* - **Tags**: Yields
|
|
11345
11482
|
*
|
|
11346
11483
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreateDockWidgetPluginGui)
|
|
11347
|
-
* @param this
|
|
11484
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11348
11485
|
* @param pluginGuiId A unique and consistent identifier used to storing the widget's dock state and other internal details.
|
|
11349
11486
|
* @param dockWidgetPluginGuiInfo Describes the `DockWidgetPluginGui` to create (initial state, size, etc).
|
|
11350
11487
|
*
|
|
@@ -11358,7 +11495,7 @@ interface Plugin extends Instance {
|
|
|
11358
11495
|
* - **Tags**: Yields
|
|
11359
11496
|
*
|
|
11360
11497
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreateDockWidgetPluginGuiAsync)
|
|
11361
|
-
* @param this
|
|
11498
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11362
11499
|
* @param pluginGuiId A unique and consistent identifier used to storing the widget's dock state and other internal details.
|
|
11363
11500
|
* @param dockWidgetPluginGuiInfo Describes the `DockWidgetPluginGui` to create (initial state, size, etc).
|
|
11364
11501
|
*/
|
|
@@ -11372,9 +11509,9 @@ interface Plugin extends Instance {
|
|
|
11372
11509
|
* - **Tags**: Yields
|
|
11373
11510
|
*
|
|
11374
11511
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxAnimation)
|
|
11375
|
-
* @param this
|
|
11376
|
-
* @param rigModel
|
|
11377
|
-
* @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`.
|
|
11378
11515
|
*
|
|
11379
11516
|
* @deprecated ImportFbxAnimationAsync
|
|
11380
11517
|
*/
|
|
@@ -11386,9 +11523,9 @@ interface Plugin extends Instance {
|
|
|
11386
11523
|
* - **Tags**: Yields
|
|
11387
11524
|
*
|
|
11388
11525
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxAnimationAsync)
|
|
11389
|
-
* @param this
|
|
11390
|
-
* @param rigModel
|
|
11391
|
-
* @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`.
|
|
11392
11529
|
*/
|
|
11393
11530
|
ImportFbxAnimationAsync(this: Plugin, rigModel: Instance, isR15?: boolean): Instance | undefined;
|
|
11394
11531
|
/**
|
|
@@ -11400,8 +11537,8 @@ interface Plugin extends Instance {
|
|
|
11400
11537
|
* - **Tags**: Yields
|
|
11401
11538
|
*
|
|
11402
11539
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxRig)
|
|
11403
|
-
* @param this
|
|
11404
|
-
* @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`.
|
|
11405
11542
|
*
|
|
11406
11543
|
* @deprecated ImportFbxRigAsync
|
|
11407
11544
|
*/
|
|
@@ -11413,8 +11550,8 @@ interface Plugin extends Instance {
|
|
|
11413
11550
|
* - **Tags**: Yields
|
|
11414
11551
|
*
|
|
11415
11552
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxRigAsync)
|
|
11416
|
-
* @param this
|
|
11417
|
-
* @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`.
|
|
11418
11555
|
*/
|
|
11419
11556
|
ImportFbxRigAsync(this: Plugin, isR15?: boolean): Instance | undefined;
|
|
11420
11557
|
/**
|
|
@@ -11424,7 +11561,7 @@ interface Plugin extends Instance {
|
|
|
11424
11561
|
* - **Tags**: Yields
|
|
11425
11562
|
*
|
|
11426
11563
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptForExistingAssetId)
|
|
11427
|
-
* @param this
|
|
11564
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11428
11565
|
* @param assetType The asset type to browse. Only `Animation` is supported.
|
|
11429
11566
|
*/
|
|
11430
11567
|
PromptForExistingAssetId(this: Plugin, assetType: string): number;
|
|
@@ -11435,7 +11572,7 @@ interface Plugin extends Instance {
|
|
|
11435
11572
|
* - **Tags**: Yields
|
|
11436
11573
|
*
|
|
11437
11574
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptForExistingAssetIdAsync)
|
|
11438
|
-
* @param this
|
|
11575
|
+
* @param this The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
|
|
11439
11576
|
* @param assetType The asset type to browse. Only `Animation` is supported.
|
|
11440
11577
|
*/
|
|
11441
11578
|
PromptForExistingAssetIdAsync(this: Plugin, assetType: string): number;
|
|
@@ -11448,8 +11585,8 @@ interface Plugin extends Instance {
|
|
|
11448
11585
|
* - **Tags**: Yields
|
|
11449
11586
|
*
|
|
11450
11587
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptSaveSelection)
|
|
11451
|
-
* @param this
|
|
11452
|
-
* @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.
|
|
11453
11590
|
*
|
|
11454
11591
|
* @deprecated PromptSaveSelectionAsync
|
|
11455
11592
|
*/
|
|
@@ -11461,8 +11598,8 @@ interface Plugin extends Instance {
|
|
|
11461
11598
|
* - **Tags**: Yields
|
|
11462
11599
|
*
|
|
11463
11600
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptSaveSelectionAsync)
|
|
11464
|
-
* @param this
|
|
11465
|
-
* @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.
|
|
11466
11603
|
*/
|
|
11467
11604
|
PromptSaveSelectionAsync(this: Plugin, suggestedFileName?: string): boolean;
|
|
11468
11605
|
/**
|
|
@@ -11483,6 +11620,8 @@ interface Plugin extends Instance {
|
|
|
11483
11620
|
readonly Unloading: RBXScriptSignal<() => void>;
|
|
11484
11621
|
}
|
|
11485
11622
|
/**
|
|
11623
|
+
* Represents a generic performable action in Roblox Studio that can optionally be bound to a keyboard shortcut.
|
|
11624
|
+
*
|
|
11486
11625
|
* - **Tags**: NotReplicated
|
|
11487
11626
|
*
|
|
11488
11627
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginAction)
|
|
@@ -11506,6 +11645,8 @@ interface PluginAction extends Instance {
|
|
|
11506
11645
|
readonly Triggered: RBXScriptSignal<() => void>;
|
|
11507
11646
|
}
|
|
11508
11647
|
/**
|
|
11648
|
+
* Declares a plugin's capabilities (the data models it targets and the permissions it requests) through a JSON manifest.
|
|
11649
|
+
*
|
|
11509
11650
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginCapabilities)
|
|
11510
11651
|
*/
|
|
11511
11652
|
interface PluginCapabilities extends Instance {
|
|
@@ -11542,6 +11683,7 @@ interface PluginConnectionService extends Instance {
|
|
|
11542
11683
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnectionService#CanHaveConnectionType)
|
|
11543
11684
|
* @param this This service is used by plugins to communicate with other instances of themselves running in other data models.
|
|
11544
11685
|
* @param type The connection type to check.
|
|
11686
|
+
* @returns Whether the current data model can potentially have connections of the given type.
|
|
11545
11687
|
*/
|
|
11546
11688
|
CanHaveConnectionType(this: PluginConnectionService, type: CastsToEnum<Enum.PluginConnectionTargetType>): boolean;
|
|
11547
11689
|
/**
|
|
@@ -11565,6 +11707,8 @@ interface PluginConnectionService extends Instance {
|
|
|
11565
11707
|
readonly Connected: RBXScriptSignal<(conn: PluginConnection) => void>;
|
|
11566
11708
|
}
|
|
11567
11709
|
/**
|
|
11710
|
+
* A service that holds the debuggable `Plugin` instances that are currently being debugged in Studio, parenting them into the data model.
|
|
11711
|
+
*
|
|
11568
11712
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
11569
11713
|
*
|
|
11570
11714
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginDebugService)
|
|
@@ -11580,6 +11724,8 @@ interface PluginDebugService extends Instance {
|
|
|
11580
11724
|
readonly _nominal_PluginDebugService: unique symbol;
|
|
11581
11725
|
}
|
|
11582
11726
|
/**
|
|
11727
|
+
* Provides information about an in-progress drag for the drag events that plugins can respond to.
|
|
11728
|
+
*
|
|
11583
11729
|
* - **Tags**: NotCreatable, NotReplicated
|
|
11584
11730
|
*
|
|
11585
11731
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginDragEvent)
|
|
@@ -11612,6 +11758,8 @@ interface PluginGuiService extends Instance {
|
|
|
11612
11758
|
readonly _nominal_PluginGuiService: unique symbol;
|
|
11613
11759
|
}
|
|
11614
11760
|
/**
|
|
11761
|
+
* Studio service that manages installed plugins; not intended for creator scripts or plugins.
|
|
11762
|
+
*
|
|
11615
11763
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
11616
11764
|
*
|
|
11617
11765
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginManagementService)
|
|
@@ -11627,6 +11775,8 @@ interface PluginManagementService extends Instance {
|
|
|
11627
11775
|
readonly _nominal_PluginManagementService: unique symbol;
|
|
11628
11776
|
}
|
|
11629
11777
|
/**
|
|
11778
|
+
* The singleton object returned by the global `PluginManager()` function, exposing a small set of legacy Studio plugin utilities.
|
|
11779
|
+
*
|
|
11630
11780
|
* - **Tags**: NotCreatable, NotReplicated
|
|
11631
11781
|
*
|
|
11632
11782
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginManagerInterface)
|
|
@@ -11643,29 +11793,36 @@ interface PluginManagerInterface extends Instance {
|
|
|
11643
11793
|
/**
|
|
11644
11794
|
* **Deprecated:** The steps to create a plugin have changed. To learn more, see `Plugin`.
|
|
11645
11795
|
*
|
|
11796
|
+
* Deprecated. Creates and returns a new `Plugin`; use `Plugin` instead.
|
|
11797
|
+
*
|
|
11646
11798
|
* - **ThreadSafety**: Unsafe
|
|
11647
11799
|
* - **Tags**: CustomLuaState
|
|
11648
11800
|
*
|
|
11649
11801
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginManagerInterface#CreatePlugin)
|
|
11650
|
-
* @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`.
|
|
11651
11804
|
*
|
|
11652
11805
|
* @deprecated
|
|
11653
11806
|
*/
|
|
11654
11807
|
CreatePlugin(this: PluginManagerInterface): Instance | undefined;
|
|
11655
11808
|
/**
|
|
11809
|
+
* Exports the entire place to an `.obj` file saved to a path chosen by the user in a file save dialog.
|
|
11810
|
+
*
|
|
11656
11811
|
* - **ThreadSafety**: Unsafe
|
|
11657
11812
|
*
|
|
11658
11813
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginManagerInterface#ExportPlace)
|
|
11659
|
-
* @param this
|
|
11660
|
-
* @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.
|
|
11661
11816
|
*/
|
|
11662
11817
|
ExportPlace(this: PluginManagerInterface, filePath?: string): void;
|
|
11663
11818
|
/**
|
|
11819
|
+
* Exports the current `Selection` to an `.obj` file saved to a path chosen by the user in a file save dialog.
|
|
11820
|
+
*
|
|
11664
11821
|
* - **ThreadSafety**: Unsafe
|
|
11665
11822
|
*
|
|
11666
11823
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginManagerInterface#ExportSelection)
|
|
11667
|
-
* @param this
|
|
11668
|
-
* @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.
|
|
11669
11826
|
*/
|
|
11670
11827
|
ExportSelection(this: PluginManagerInterface, filePath?: string): void;
|
|
11671
11828
|
}
|
|
@@ -11764,6 +11921,8 @@ interface PluginPolicyService extends Instance {
|
|
|
11764
11921
|
readonly _nominal_PluginPolicyService: unique symbol;
|
|
11765
11922
|
}
|
|
11766
11923
|
/**
|
|
11924
|
+
* A toolbar created by `Plugin:CreateToolbar()` that groups `PluginToolbarButtons` in the Studio ribbon.
|
|
11925
|
+
*
|
|
11767
11926
|
* - **Tags**: NotCreatable
|
|
11768
11927
|
*
|
|
11769
11928
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginToolbar)
|
|
@@ -11783,7 +11942,7 @@ interface PluginToolbar extends Instance {
|
|
|
11783
11942
|
* - **ThreadSafety**: Unsafe
|
|
11784
11943
|
*
|
|
11785
11944
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginToolbar#CreateButton)
|
|
11786
|
-
* @param this
|
|
11945
|
+
* @param this A toolbar created by `Plugin:CreateToolbar()` that groups `PluginToolbarButtons` in the Studio ribbon.
|
|
11787
11946
|
* @param buttonId A unique button ID.
|
|
11788
11947
|
* @param tooltip The text displayed in the tooltip shown when a user hovers over the button.
|
|
11789
11948
|
* @param iconname The asset ID of the icon displayed in the button.
|
|
@@ -11793,6 +11952,8 @@ interface PluginToolbar extends Instance {
|
|
|
11793
11952
|
CreateButton(this: PluginToolbar, buttonId: string, tooltip: string, iconname: string, text?: string): PluginToolbarButton;
|
|
11794
11953
|
}
|
|
11795
11954
|
/**
|
|
11955
|
+
* A button on a `PluginToolbar` in the Studio ribbon, created by `PluginToolbar:CreateButton()`, that fires `Click` when pressed.
|
|
11956
|
+
*
|
|
11796
11957
|
* - **Tags**: NotCreatable
|
|
11797
11958
|
*
|
|
11798
11959
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginToolbarButton)
|
|
@@ -11807,6 +11968,8 @@ interface PluginToolbarButton extends Instance {
|
|
|
11807
11968
|
*/
|
|
11808
11969
|
readonly _nominal_PluginToolbarButton: unique symbol;
|
|
11809
11970
|
/**
|
|
11971
|
+
* The content of the image used as the button's icon in the toolbar. Only supports asset URIs.
|
|
11972
|
+
*
|
|
11810
11973
|
* - **ThreadSafety**: ReadSafe
|
|
11811
11974
|
* - **Tags**: NotReplicated
|
|
11812
11975
|
*
|
|
@@ -11819,8 +11982,8 @@ interface PluginToolbarButton extends Instance {
|
|
|
11819
11982
|
* - **ThreadSafety**: Unsafe
|
|
11820
11983
|
*
|
|
11821
11984
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginToolbarButton#SetActive)
|
|
11822
|
-
* @param this
|
|
11823
|
-
* @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`).
|
|
11824
11987
|
*/
|
|
11825
11988
|
SetActive(this: PluginToolbarButton, active: boolean): void;
|
|
11826
11989
|
/**
|
|
@@ -12049,6 +12212,8 @@ interface ProceduralBehaviorSchedulerService extends Instance {
|
|
|
12049
12212
|
readonly _nominal_ProceduralBehaviorSchedulerService: unique symbol;
|
|
12050
12213
|
}
|
|
12051
12214
|
/**
|
|
12215
|
+
* An internal engine service that generates collision geometry (physics data) for `MeshPart` and `PartOperation` instances that need new physics.
|
|
12216
|
+
*
|
|
12052
12217
|
* - **Tags**: NotCreatable, Service
|
|
12053
12218
|
*
|
|
12054
12219
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProcessInstancePhysicsService)
|
|
@@ -12096,6 +12261,8 @@ interface ProximityPromptService extends Instance {
|
|
|
12096
12261
|
readonly _nominal_ProximityPromptService: unique symbol;
|
|
12097
12262
|
}
|
|
12098
12263
|
/**
|
|
12264
|
+
* A service that centralizes uploading assets to Roblox, including publishing cage mesh edits and creating assets or asset versions.
|
|
12265
|
+
*
|
|
12099
12266
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
12100
12267
|
*
|
|
12101
12268
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PublishService)
|
|
@@ -12171,6 +12338,8 @@ interface ReflectionService extends Instance {
|
|
|
12171
12338
|
readonly _nominal_ReflectionService: unique symbol;
|
|
12172
12339
|
}
|
|
12173
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
|
+
*
|
|
12174
12343
|
* - **Tags**: NotCreatable, Service
|
|
12175
12344
|
*
|
|
12176
12345
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteCommandService)
|
|
@@ -12201,6 +12370,8 @@ interface RemoteCursorService extends Instance {
|
|
|
12201
12370
|
readonly _nominal_RemoteCursorService: unique symbol;
|
|
12202
12371
|
}
|
|
12203
12372
|
/**
|
|
12373
|
+
* Studio service that runs the server side of Luau remote debugging over DAP; not created during normal script execution.
|
|
12374
|
+
*
|
|
12204
12375
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
12205
12376
|
*
|
|
12206
12377
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteDebuggerServer)
|
|
@@ -12231,6 +12402,8 @@ interface RemoteFunction<T extends Callback = Callback> extends Instance {
|
|
|
12231
12402
|
readonly _nominal_RemoteFunction: unique symbol;
|
|
12232
12403
|
}
|
|
12233
12404
|
/**
|
|
12405
|
+
* A singleton settings class that exposes rendering configuration for graphics quality, framerate management, and debug visualization in Roblox Studio.
|
|
12406
|
+
*
|
|
12234
12407
|
* - **Tags**: NotCreatable, Service, NotReplicated, NotBrowsable
|
|
12235
12408
|
*
|
|
12236
12409
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RenderSettings)
|
|
@@ -12278,6 +12451,8 @@ interface RenderSettings extends Instance {
|
|
|
12278
12451
|
*/
|
|
12279
12452
|
EnableFRM: boolean;
|
|
12280
12453
|
/**
|
|
12454
|
+
* Toggles whether virtual reality (VR) mode is enabled.
|
|
12455
|
+
*
|
|
12281
12456
|
* - **ThreadSafety**: ReadSafe
|
|
12282
12457
|
*
|
|
12283
12458
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RenderSettings#Enable VR Mode)
|
|
@@ -12356,6 +12531,8 @@ interface RenderSettings extends Instance {
|
|
|
12356
12531
|
*/
|
|
12357
12532
|
ShowBoundingBoxes: boolean;
|
|
12358
12533
|
/**
|
|
12534
|
+
* Studio only. Selects a debug rendering visualization overlay for the viewport.
|
|
12535
|
+
*
|
|
12359
12536
|
* - **ThreadSafety**: ReadSafe
|
|
12360
12537
|
*
|
|
12361
12538
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RenderSettings#ViewMode)
|
|
@@ -12367,13 +12544,12 @@ interface RenderSettings extends Instance {
|
|
|
12367
12544
|
* - **ThreadSafety**: Unsafe
|
|
12368
12545
|
*
|
|
12369
12546
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RenderSettings#GetMaxQualityLevel)
|
|
12370
|
-
* @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.
|
|
12371
12549
|
*/
|
|
12372
12550
|
GetMaxQualityLevel(this: RenderSettings): number;
|
|
12373
12551
|
}
|
|
12374
12552
|
/**
|
|
12375
|
-
* An internal testing utility for the rendering pipeline.
|
|
12376
|
-
*
|
|
12377
12553
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RenderingTest)
|
|
12378
12554
|
*/
|
|
12379
12555
|
interface RenderingTest extends Instance {
|
|
@@ -12813,6 +12989,8 @@ interface ScriptCommitService extends Instance {
|
|
|
12813
12989
|
readonly _nominal_ScriptCommitService: unique symbol;
|
|
12814
12990
|
}
|
|
12815
12991
|
/**
|
|
12992
|
+
* A service that manages the execution of all `BaseScript` objects.
|
|
12993
|
+
*
|
|
12816
12994
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
12817
12995
|
*
|
|
12818
12996
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext)
|
|
@@ -12832,8 +13010,8 @@ interface ScriptContext extends Instance {
|
|
|
12832
13010
|
* - **ThreadSafety**: Unsafe
|
|
12833
13011
|
*
|
|
12834
13012
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#SetTimeout)
|
|
12835
|
-
* @param this
|
|
12836
|
-
* @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.
|
|
12837
13015
|
*/
|
|
12838
13016
|
SetTimeout(this: ScriptContext, seconds: number): void;
|
|
12839
13017
|
}
|
|
@@ -13021,6 +13199,8 @@ interface ScriptDebuggerService extends Instance {
|
|
|
13021
13199
|
OnStopped: ((stopped: object) => object) | undefined;
|
|
13022
13200
|
}
|
|
13023
13201
|
/**
|
|
13202
|
+
* Represents the ephemeral state of an open document in the Studio Script Editor, providing APIs for reading and editing code.
|
|
13203
|
+
*
|
|
13024
13204
|
* - **Tags**: NotCreatable, NotReplicated
|
|
13025
13205
|
*
|
|
13026
13206
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument)
|
|
@@ -13040,8 +13220,9 @@ interface ScriptDocument extends Instance {
|
|
|
13040
13220
|
* - **ThreadSafety**: Unsafe
|
|
13041
13221
|
*
|
|
13042
13222
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetLine)
|
|
13043
|
-
* @param this
|
|
13044
|
-
* @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.
|
|
13045
13226
|
*/
|
|
13046
13227
|
GetLine(this: ScriptDocument, lineIndex?: number): string;
|
|
13047
13228
|
/**
|
|
@@ -13050,7 +13231,8 @@ interface ScriptDocument extends Instance {
|
|
|
13050
13231
|
* - **ThreadSafety**: Unsafe
|
|
13051
13232
|
*
|
|
13052
13233
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetLineCount)
|
|
13053
|
-
* @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.
|
|
13054
13236
|
*/
|
|
13055
13237
|
GetLineCount(this: ScriptDocument): number;
|
|
13056
13238
|
/**
|
|
@@ -13059,7 +13241,8 @@ interface ScriptDocument extends Instance {
|
|
|
13059
13241
|
* - **ThreadSafety**: Unsafe
|
|
13060
13242
|
*
|
|
13061
13243
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetScript)
|
|
13062
|
-
* @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).
|
|
13063
13246
|
*/
|
|
13064
13247
|
GetScript(this: ScriptDocument): LuaSourceContainer;
|
|
13065
13248
|
/**
|
|
@@ -13068,7 +13251,8 @@ interface ScriptDocument extends Instance {
|
|
|
13068
13251
|
* - **ThreadSafety**: Unsafe
|
|
13069
13252
|
*
|
|
13070
13253
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetSelectedText)
|
|
13071
|
-
* @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.
|
|
13072
13256
|
*/
|
|
13073
13257
|
GetSelectedText(this: ScriptDocument): string;
|
|
13074
13258
|
/**
|
|
@@ -13077,7 +13261,7 @@ interface ScriptDocument extends Instance {
|
|
|
13077
13261
|
* - **ThreadSafety**: Unsafe
|
|
13078
13262
|
*
|
|
13079
13263
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetSelection)
|
|
13080
|
-
* @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.
|
|
13081
13265
|
* @returns CursorLine, CursorChar, AnchorLine, AnchorChar.
|
|
13082
13266
|
*/
|
|
13083
13267
|
GetSelection(this: ScriptDocument): unknown;
|
|
@@ -13087,7 +13271,8 @@ interface ScriptDocument extends Instance {
|
|
|
13087
13271
|
* - **ThreadSafety**: Unsafe
|
|
13088
13272
|
*
|
|
13089
13273
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetSelectionEnd)
|
|
13090
|
-
* @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.
|
|
13091
13276
|
*/
|
|
13092
13277
|
GetSelectionEnd(this: ScriptDocument): unknown;
|
|
13093
13278
|
/**
|
|
@@ -13096,7 +13281,8 @@ interface ScriptDocument extends Instance {
|
|
|
13096
13281
|
* - **ThreadSafety**: Unsafe
|
|
13097
13282
|
*
|
|
13098
13283
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetSelectionStart)
|
|
13099
|
-
* @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.
|
|
13100
13286
|
*/
|
|
13101
13287
|
GetSelectionStart(this: ScriptDocument): unknown;
|
|
13102
13288
|
/**
|
|
@@ -13105,11 +13291,12 @@ interface ScriptDocument extends Instance {
|
|
|
13105
13291
|
* - **ThreadSafety**: Unsafe
|
|
13106
13292
|
*
|
|
13107
13293
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetText)
|
|
13108
|
-
* @param this
|
|
13109
|
-
* @param startLine
|
|
13110
|
-
* @param startCharacter
|
|
13111
|
-
* @param endLine
|
|
13112
|
-
* @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.
|
|
13113
13300
|
*/
|
|
13114
13301
|
GetText(this: ScriptDocument, startLine?: number, startCharacter?: number, endLine?: number, endCharacter?: number): string;
|
|
13115
13302
|
/**
|
|
@@ -13118,7 +13305,8 @@ interface ScriptDocument extends Instance {
|
|
|
13118
13305
|
* - **ThreadSafety**: Unsafe
|
|
13119
13306
|
*
|
|
13120
13307
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetViewport)
|
|
13121
|
-
* @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.
|
|
13122
13310
|
*/
|
|
13123
13311
|
GetViewport(this: ScriptDocument): unknown;
|
|
13124
13312
|
/**
|
|
@@ -13127,7 +13315,8 @@ interface ScriptDocument extends Instance {
|
|
|
13127
13315
|
* - **ThreadSafety**: Unsafe
|
|
13128
13316
|
*
|
|
13129
13317
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#HasSelectedText)
|
|
13130
|
-
* @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.
|
|
13131
13320
|
*/
|
|
13132
13321
|
HasSelectedText(this: ScriptDocument): boolean;
|
|
13133
13322
|
/**
|
|
@@ -13136,7 +13325,8 @@ interface ScriptDocument extends Instance {
|
|
|
13136
13325
|
* - **ThreadSafety**: Unsafe
|
|
13137
13326
|
*
|
|
13138
13327
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#IsCommandBar)
|
|
13139
|
-
* @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.
|
|
13140
13330
|
*/
|
|
13141
13331
|
IsCommandBar(this: ScriptDocument): boolean;
|
|
13142
13332
|
/**
|
|
@@ -13146,7 +13336,8 @@ interface ScriptDocument extends Instance {
|
|
|
13146
13336
|
* - **Tags**: Yields
|
|
13147
13337
|
*
|
|
13148
13338
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#CloseAsync)
|
|
13149
|
-
* @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.
|
|
13150
13341
|
*/
|
|
13151
13342
|
CloseAsync(this: ScriptDocument): unknown;
|
|
13152
13343
|
/**
|
|
@@ -13156,12 +13347,13 @@ interface ScriptDocument extends Instance {
|
|
|
13156
13347
|
* - **Tags**: Yields
|
|
13157
13348
|
*
|
|
13158
13349
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#EditTextAsync)
|
|
13159
|
-
* @param this
|
|
13160
|
-
* @param newText
|
|
13161
|
-
* @param startLine
|
|
13162
|
-
* @param startCharacter
|
|
13163
|
-
* @param endLine
|
|
13164
|
-
* @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.
|
|
13165
13357
|
*/
|
|
13166
13358
|
EditTextAsync(this: ScriptDocument, newText: string, startLine: number, startCharacter: number, endLine: number, endCharacter: number): unknown;
|
|
13167
13359
|
/**
|
|
@@ -13171,20 +13363,24 @@ interface ScriptDocument extends Instance {
|
|
|
13171
13363
|
* - **Tags**: Yields
|
|
13172
13364
|
*
|
|
13173
13365
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#ForceSetSelectionAsync)
|
|
13174
|
-
* @param this
|
|
13175
|
-
* @param cursorLine
|
|
13176
|
-
* @param cursorCharacter
|
|
13177
|
-
* @param anchorLine
|
|
13178
|
-
* @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.
|
|
13179
13372
|
*/
|
|
13180
13373
|
ForceSetSelectionAsync(this: ScriptDocument, cursorLine: number, cursorCharacter: number, anchorLine?: number, anchorCharacter?: number): unknown;
|
|
13181
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
|
+
*
|
|
13182
13377
|
* - **ThreadSafety**: Unsafe
|
|
13183
13378
|
* - **Tags**: Yields
|
|
13184
13379
|
*
|
|
13185
13380
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#MultiEditTextAsync)
|
|
13186
|
-
* @param this
|
|
13187
|
-
* @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.
|
|
13188
13384
|
*/
|
|
13189
13385
|
MultiEditTextAsync(this: ScriptDocument, edits: Array<unknown>): unknown;
|
|
13190
13386
|
/**
|
|
@@ -13194,18 +13390,24 @@ interface ScriptDocument extends Instance {
|
|
|
13194
13390
|
* - **Tags**: Yields
|
|
13195
13391
|
*
|
|
13196
13392
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#RequestSetSelectionAsync)
|
|
13197
|
-
* @param this
|
|
13198
|
-
* @param cursorLine
|
|
13199
|
-
* @param cursorCharacter
|
|
13200
|
-
* @param anchorLine
|
|
13201
|
-
* @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.
|
|
13202
13399
|
*/
|
|
13203
13400
|
RequestSetSelectionAsync(this: ScriptDocument, cursorLine: number, cursorCharacter: number, anchorLine?: number, anchorCharacter?: number): unknown;
|
|
13204
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
|
+
*
|
|
13205
13404
|
* - **ThreadSafety**: Unsafe
|
|
13206
13405
|
* - **Tags**: Yields
|
|
13207
13406
|
*
|
|
13208
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.
|
|
13209
13411
|
*/
|
|
13210
13412
|
ReviewableTextEditsAsync(this: ScriptDocument, changes: Array<unknown>): unknown;
|
|
13211
13413
|
/**
|
|
@@ -13248,7 +13450,7 @@ interface ScriptEditorService extends Instance {
|
|
|
13248
13450
|
*
|
|
13249
13451
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#DeregisterAutocompleteCallback)
|
|
13250
13452
|
* @param this This service is used for interacting with `ScriptDocument` instances.
|
|
13251
|
-
* @param name
|
|
13453
|
+
* @param name The identifier that was used when registering the callback with `ScriptEditorService:RegisterAutocompleteCallback()`.
|
|
13252
13454
|
*/
|
|
13253
13455
|
DeregisterAutocompleteCallback(this: ScriptEditorService, name: string): void;
|
|
13254
13456
|
/**
|
|
@@ -13258,7 +13460,7 @@ interface ScriptEditorService extends Instance {
|
|
|
13258
13460
|
*
|
|
13259
13461
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#DeregisterScriptAnalysisCallback)
|
|
13260
13462
|
* @param this This service is used for interacting with `ScriptDocument` instances.
|
|
13261
|
-
* @param name
|
|
13463
|
+
* @param name The identifier that was used when registering the callback with `ScriptEditorService:RegisterScriptAnalysisCallback()`.
|
|
13262
13464
|
*/
|
|
13263
13465
|
DeregisterScriptAnalysisCallback(this: ScriptEditorService, name: string): void;
|
|
13264
13466
|
/**
|
|
@@ -13268,7 +13470,8 @@ interface ScriptEditorService extends Instance {
|
|
|
13268
13470
|
*
|
|
13269
13471
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#FindScriptDocument)
|
|
13270
13472
|
* @param this This service is used for interacting with `ScriptDocument` instances.
|
|
13271
|
-
* @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.
|
|
13272
13475
|
*/
|
|
13273
13476
|
FindScriptDocument(this: ScriptEditorService, script: LuaSourceContainer): ScriptDocument;
|
|
13274
13477
|
/**
|
|
@@ -13278,7 +13481,8 @@ interface ScriptEditorService extends Instance {
|
|
|
13278
13481
|
*
|
|
13279
13482
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#GetEditorSource)
|
|
13280
13483
|
* @param this This service is used for interacting with `ScriptDocument` instances.
|
|
13281
|
-
* @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.
|
|
13282
13486
|
*/
|
|
13283
13487
|
GetEditorSource(this: ScriptEditorService, script: LuaSourceContainer): string;
|
|
13284
13488
|
/**
|
|
@@ -13288,6 +13492,7 @@ interface ScriptEditorService extends Instance {
|
|
|
13288
13492
|
*
|
|
13289
13493
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#GetScriptDocuments)
|
|
13290
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.
|
|
13291
13496
|
*/
|
|
13292
13497
|
GetScriptDocuments(this: ScriptEditorService): Array<Instance>;
|
|
13293
13498
|
/**
|
|
@@ -13297,9 +13502,9 @@ interface ScriptEditorService extends Instance {
|
|
|
13297
13502
|
*
|
|
13298
13503
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#RegisterAutocompleteCallback)
|
|
13299
13504
|
* @param this This service is used for interacting with `ScriptDocument` instances.
|
|
13300
|
-
* @param name
|
|
13301
|
-
* @param priority
|
|
13302
|
-
* @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`.
|
|
13303
13508
|
*/
|
|
13304
13509
|
RegisterAutocompleteCallback(this: ScriptEditorService, name: string, priority: number, callbackFunction: Callback): void;
|
|
13305
13510
|
/**
|
|
@@ -13309,9 +13514,9 @@ interface ScriptEditorService extends Instance {
|
|
|
13309
13514
|
*
|
|
13310
13515
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#RegisterScriptAnalysisCallback)
|
|
13311
13516
|
* @param this This service is used for interacting with `ScriptDocument` instances.
|
|
13312
|
-
* @param name
|
|
13313
|
-
* @param priority
|
|
13314
|
-
* @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.
|
|
13315
13520
|
*/
|
|
13316
13521
|
RegisterScriptAnalysisCallback(this: ScriptEditorService, name: string, priority: number, callbackFunction: Callback): void;
|
|
13317
13522
|
/**
|
|
@@ -13322,9 +13527,12 @@ interface ScriptEditorService extends Instance {
|
|
|
13322
13527
|
*
|
|
13323
13528
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#OpenScriptDocumentAsync)
|
|
13324
13529
|
* @param this This service is used for interacting with `ScriptDocument` instances.
|
|
13325
|
-
* @param script
|
|
13530
|
+
* @param script The `LuaSourceContainer` to open in the Script Editor.
|
|
13326
13531
|
* @param options A dictionary that supports the following options: - `Temporary` — Boolean. Whether to open the script in a preview tab. Default is false.
|
|
13327
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.
|
|
13328
13536
|
*/
|
|
13329
13537
|
OpenScriptDocumentAsync(this: ScriptEditorService, script: LuaSourceContainer, options?: object): unknown;
|
|
13330
13538
|
/**
|
|
@@ -13365,6 +13573,8 @@ interface ScriptEditorService extends Instance {
|
|
|
13365
13573
|
readonly TextDocumentDidOpen: RBXScriptSignal<(newDocument: ScriptDocument) => void>;
|
|
13366
13574
|
}
|
|
13367
13575
|
/**
|
|
13576
|
+
* A service that captures sampling-based profiles of Luau script execution on the server or on a client.
|
|
13577
|
+
*
|
|
13368
13578
|
* - **Tags**: NotCreatable, Service
|
|
13369
13579
|
*
|
|
13370
13580
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService)
|
|
@@ -13379,62 +13589,79 @@ interface ScriptProfilerService extends Instance {
|
|
|
13379
13589
|
*/
|
|
13380
13590
|
readonly _nominal_ScriptProfilerService: unique symbol;
|
|
13381
13591
|
/**
|
|
13592
|
+
* Requests the current script profiling data from the specified player's client.
|
|
13593
|
+
*
|
|
13382
13594
|
* - **ThreadSafety**: Unsafe
|
|
13383
13595
|
*
|
|
13384
13596
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ClientRequestData)
|
|
13385
|
-
* @param this
|
|
13386
|
-
* @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.
|
|
13387
13599
|
*/
|
|
13388
13600
|
ClientRequestData(this: ScriptProfilerService, player: Player): void;
|
|
13389
13601
|
/**
|
|
13602
|
+
* Begins Luau script profiling for the specified player's client.
|
|
13603
|
+
*
|
|
13390
13604
|
* - **ThreadSafety**: Unsafe
|
|
13391
13605
|
*
|
|
13392
13606
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ClientStart)
|
|
13393
|
-
* @param this
|
|
13394
|
-
* @param player
|
|
13395
|
-
* @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]`.
|
|
13396
13610
|
*/
|
|
13397
13611
|
ClientStart(this: ScriptProfilerService, player: Player, frequency?: number): void;
|
|
13398
13612
|
/**
|
|
13613
|
+
* Stops Luau script profiling for the specified player's client.
|
|
13614
|
+
*
|
|
13399
13615
|
* - **ThreadSafety**: Unsafe
|
|
13400
13616
|
*
|
|
13401
13617
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ClientStop)
|
|
13402
|
-
* @param this
|
|
13403
|
-
* @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.
|
|
13404
13620
|
*/
|
|
13405
13621
|
ClientStop(this: ScriptProfilerService, player: Player): void;
|
|
13406
13622
|
/**
|
|
13623
|
+
* Parses a script-profiling JSON string into a structured Luau table.
|
|
13624
|
+
*
|
|
13407
13625
|
* - **ThreadSafety**: Unsafe
|
|
13408
13626
|
* - **Tags**: CustomLuaState
|
|
13409
13627
|
*
|
|
13410
13628
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#DeserializeJSON)
|
|
13411
|
-
* @param this
|
|
13412
|
-
* @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.
|
|
13413
13632
|
*/
|
|
13414
13633
|
DeserializeJSON(this: ScriptProfilerService, jsonString?: string): object;
|
|
13415
13634
|
/**
|
|
13635
|
+
* Requests the current script profiling data from the server.
|
|
13636
|
+
*
|
|
13416
13637
|
* - **ThreadSafety**: Unsafe
|
|
13417
13638
|
*
|
|
13418
13639
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ServerRequestData)
|
|
13419
|
-
* @param this
|
|
13640
|
+
* @param this A service that captures sampling-based profiles of Luau script execution on the server or on a client.
|
|
13420
13641
|
*/
|
|
13421
13642
|
ServerRequestData(this: ScriptProfilerService): void;
|
|
13422
13643
|
/**
|
|
13644
|
+
* Begins Luau script profiling on the server.
|
|
13645
|
+
*
|
|
13423
13646
|
* - **ThreadSafety**: Unsafe
|
|
13424
13647
|
*
|
|
13425
13648
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ServerStart)
|
|
13426
|
-
* @param this
|
|
13427
|
-
* @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]`.
|
|
13428
13651
|
*/
|
|
13429
13652
|
ServerStart(this: ScriptProfilerService, frequency?: number): void;
|
|
13430
13653
|
/**
|
|
13654
|
+
* Stops Luau script profiling on the server.
|
|
13655
|
+
*
|
|
13431
13656
|
* - **ThreadSafety**: Unsafe
|
|
13432
13657
|
*
|
|
13433
13658
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ServerStop)
|
|
13434
|
-
* @param this
|
|
13659
|
+
* @param this A service that captures sampling-based profiles of Luau script execution on the server or on a client.
|
|
13435
13660
|
*/
|
|
13436
13661
|
ServerStop(this: ScriptProfilerService): void;
|
|
13437
13662
|
/**
|
|
13663
|
+
* Fires when a new profiling data snapshot becomes available after a data request.
|
|
13664
|
+
*
|
|
13438
13665
|
* - **ThreadSafety**: Unsafe
|
|
13439
13666
|
*
|
|
13440
13667
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#OnNewData)
|
|
@@ -13471,6 +13698,21 @@ interface ScriptRuntime extends Instance {
|
|
|
13471
13698
|
*/
|
|
13472
13699
|
readonly _nominal_ScriptRuntime: unique symbol;
|
|
13473
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
|
+
}
|
|
13474
13716
|
/**
|
|
13475
13717
|
* The Selection service controls the `Instances` that are selected in Roblox Studio.
|
|
13476
13718
|
*
|
|
@@ -13529,6 +13771,8 @@ interface Selection extends Instance {
|
|
|
13529
13771
|
Set(this: Selection, selection: Array<Instance>): void;
|
|
13530
13772
|
}
|
|
13531
13773
|
/**
|
|
13774
|
+
* Studio service that draws selection outline highlights for the local user's selection and for Team Create collaborators' selections.
|
|
13775
|
+
*
|
|
13532
13776
|
* - **Tags**: NotCreatable, Service
|
|
13533
13777
|
*
|
|
13534
13778
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelectionHighlightManager)
|
|
@@ -13591,6 +13835,8 @@ interface BuoyancySensor extends SensorBase {
|
|
|
13591
13835
|
readonly _nominal_BuoyancySensor: unique symbol;
|
|
13592
13836
|
}
|
|
13593
13837
|
/**
|
|
13838
|
+
* An abstract base class for `SensorBase` types that supply sensory data to a character controller.
|
|
13839
|
+
*
|
|
13594
13840
|
* - **Tags**: NotCreatable
|
|
13595
13841
|
*
|
|
13596
13842
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerSensor)
|
|
@@ -15680,16 +15926,20 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
15680
15926
|
*/
|
|
15681
15927
|
readonly _nominal_StudioDeviceSimulatorService: unique symbol;
|
|
15682
15928
|
/**
|
|
15929
|
+
* Creates a custom device preset and returns its ID.
|
|
15930
|
+
*
|
|
15683
15931
|
* - **ThreadSafety**: Unsafe
|
|
15684
15932
|
* - **Tags**: Yields
|
|
15685
15933
|
*
|
|
15686
15934
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#CreateDeviceAsync)
|
|
15687
15935
|
* @param this Service allowing you to control Studio's Device Simulator.
|
|
15688
|
-
* @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).
|
|
15689
15937
|
* @returns string
|
|
15690
15938
|
*/
|
|
15691
15939
|
CreateDeviceAsync(this: StudioDeviceSimulatorService, config: object): string;
|
|
15692
15940
|
/**
|
|
15941
|
+
* Returns the ID of the currently active device, or `"default"` if none is active.
|
|
15942
|
+
*
|
|
15693
15943
|
* - **ThreadSafety**: Unsafe
|
|
15694
15944
|
* - **Tags**: Yields
|
|
15695
15945
|
*
|
|
@@ -15699,16 +15949,20 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
15699
15949
|
*/
|
|
15700
15950
|
GetDeviceAsync(this: StudioDeviceSimulatorService): string;
|
|
15701
15951
|
/**
|
|
15952
|
+
* Returns the configuration dictionary for the specified device.
|
|
15953
|
+
*
|
|
15702
15954
|
* - **ThreadSafety**: Unsafe
|
|
15703
15955
|
* - **Tags**: Yields
|
|
15704
15956
|
*
|
|
15705
15957
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetDeviceInfoAsync)
|
|
15706
15958
|
* @param this Service allowing you to control Studio's Device Simulator.
|
|
15707
|
-
* @param deviceId
|
|
15959
|
+
* @param deviceId The unique identifier of the device to query. Must be a valid ID from `GetDeviceListAsync()`; cannot be `"default"`.
|
|
15708
15960
|
* @returns A dictionary containing the device configuration and passed to `CreateDeviceAsync` and `UpdateDeviceAsync`.
|
|
15709
15961
|
*/
|
|
15710
15962
|
GetDeviceInfoAsync(this: StudioDeviceSimulatorService, deviceId: string): object;
|
|
15711
15963
|
/**
|
|
15964
|
+
* Returns an array of all available device IDs.
|
|
15965
|
+
*
|
|
15712
15966
|
* - **ThreadSafety**: Unsafe
|
|
15713
15967
|
* - **Tags**: Yields
|
|
15714
15968
|
*
|
|
@@ -15718,6 +15972,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
15718
15972
|
*/
|
|
15719
15973
|
GetDeviceListAsync(this: StudioDeviceSimulatorService): Array<unknown>;
|
|
15720
15974
|
/**
|
|
15975
|
+
* Returns the current simulated screen orientation.
|
|
15976
|
+
*
|
|
15721
15977
|
* - **ThreadSafety**: Unsafe
|
|
15722
15978
|
* - **Tags**: Yields
|
|
15723
15979
|
*
|
|
@@ -15727,6 +15983,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
15727
15983
|
*/
|
|
15728
15984
|
GetOrientationAsync(this: StudioDeviceSimulatorService): Enum.ScreenOrientation;
|
|
15729
15985
|
/**
|
|
15986
|
+
* Returns the current simulated pixel density in DPI.
|
|
15987
|
+
*
|
|
15730
15988
|
* - **ThreadSafety**: Unsafe
|
|
15731
15989
|
* - **Tags**: Yields
|
|
15732
15990
|
*
|
|
@@ -15736,6 +15994,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
15736
15994
|
*/
|
|
15737
15995
|
GetPixelDensityAsync(this: StudioDeviceSimulatorService): number;
|
|
15738
15996
|
/**
|
|
15997
|
+
* Returns the current simulated viewport resolution.
|
|
15998
|
+
*
|
|
15739
15999
|
* - **ThreadSafety**: Unsafe
|
|
15740
16000
|
* - **Tags**: Yields
|
|
15741
16001
|
*
|
|
@@ -15745,70 +16005,86 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
15745
16005
|
*/
|
|
15746
16006
|
GetResolutionAsync(this: StudioDeviceSimulatorService): Vector2;
|
|
15747
16007
|
/**
|
|
16008
|
+
* Returns how the simulated resolution currently maps to the Studio viewport.
|
|
16009
|
+
*
|
|
15748
16010
|
* - **ThreadSafety**: Unsafe
|
|
15749
16011
|
* - **Tags**: Yields
|
|
15750
16012
|
*
|
|
15751
16013
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetScalingModeAsync)
|
|
15752
16014
|
* @param this Service allowing you to control Studio's Device Simulator.
|
|
15753
|
-
* @returns DeviceSimulatorScalingMode
|
|
16015
|
+
* @returns The current `DeviceSimulatorScalingMode`.
|
|
15754
16016
|
*/
|
|
15755
16017
|
GetScalingModeAsync(this: StudioDeviceSimulatorService): Enum.DeviceSimulatorScalingMode;
|
|
15756
16018
|
/**
|
|
16019
|
+
* Removes a custom device from the catalog.
|
|
16020
|
+
*
|
|
15757
16021
|
* - **ThreadSafety**: Unsafe
|
|
15758
16022
|
* - **Tags**: Yields
|
|
15759
16023
|
*
|
|
15760
16024
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#RemoveDeviceAsync)
|
|
15761
16025
|
* @param this Service allowing you to control Studio's Device Simulator.
|
|
15762
|
-
* @param deviceId
|
|
16026
|
+
* @param deviceId The unique identifier of the custom device to remove.
|
|
15763
16027
|
*/
|
|
15764
16028
|
RemoveDeviceAsync(this: StudioDeviceSimulatorService, deviceId: string): void;
|
|
15765
16029
|
/**
|
|
16030
|
+
* Activates the specified device or stops simulation if `"default"` is passed.
|
|
16031
|
+
*
|
|
15766
16032
|
* - **ThreadSafety**: Unsafe
|
|
15767
16033
|
* - **Tags**: Yields
|
|
15768
16034
|
*
|
|
15769
16035
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetDeviceAsync)
|
|
15770
16036
|
* @param this Service allowing you to control Studio's Device Simulator.
|
|
15771
|
-
* @param deviceId
|
|
16037
|
+
* @param deviceId The unique identifier of the device to activate, or `"default"` to stop simulation.
|
|
15772
16038
|
*/
|
|
15773
16039
|
SetDeviceAsync(this: StudioDeviceSimulatorService, deviceId: string): void;
|
|
15774
16040
|
/**
|
|
16041
|
+
* Sets the simulated screen orientation.
|
|
16042
|
+
*
|
|
15775
16043
|
* - **ThreadSafety**: Unsafe
|
|
15776
16044
|
* - **Tags**: Yields
|
|
15777
16045
|
*
|
|
15778
16046
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetOrientationAsync)
|
|
15779
16047
|
* @param this Service allowing you to control Studio's Device Simulator.
|
|
15780
|
-
* @param orientation
|
|
16048
|
+
* @param orientation The target screen orientation. Accepted values are `ScreenOrientation.Portrait`, `ScreenOrientation.LandscapeLeft`, or `ScreenOrientation.LandscapeRight`.
|
|
15781
16049
|
*/
|
|
15782
16050
|
SetOrientationAsync(this: StudioDeviceSimulatorService, orientation: CastsToEnum<Enum.ScreenOrientation>): void;
|
|
15783
16051
|
/**
|
|
16052
|
+
* Overrides the simulated pixel density in DPI for the current session.
|
|
16053
|
+
*
|
|
15784
16054
|
* - **ThreadSafety**: Unsafe
|
|
15785
16055
|
* - **Tags**: Yields
|
|
15786
16056
|
*
|
|
15787
16057
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetPixelDensityAsync)
|
|
15788
16058
|
* @param this Service allowing you to control Studio's Device Simulator.
|
|
15789
|
-
* @param density
|
|
16059
|
+
* @param density The pixel density override in DPI. Must be between 72 and 10000.
|
|
15790
16060
|
*/
|
|
15791
16061
|
SetPixelDensityAsync(this: StudioDeviceSimulatorService, density: number): void;
|
|
15792
16062
|
/**
|
|
16063
|
+
* Overrides the simulated viewport resolution for the current session.
|
|
16064
|
+
*
|
|
15793
16065
|
* - **ThreadSafety**: Unsafe
|
|
15794
16066
|
* - **Tags**: Yields
|
|
15795
16067
|
*
|
|
15796
16068
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetResolutionAsync)
|
|
15797
16069
|
* @param this Service allowing you to control Studio's Device Simulator.
|
|
15798
|
-
* @param width
|
|
15799
|
-
* @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.
|
|
15800
16072
|
*/
|
|
15801
16073
|
SetResolutionAsync(this: StudioDeviceSimulatorService, width: number, height: number): void;
|
|
15802
16074
|
/**
|
|
16075
|
+
* Sets how the simulated resolution maps to the Studio viewport.
|
|
16076
|
+
*
|
|
15803
16077
|
* - **ThreadSafety**: Unsafe
|
|
15804
16078
|
* - **Tags**: Yields
|
|
15805
16079
|
*
|
|
15806
16080
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetScalingModeAsync)
|
|
15807
16081
|
* @param this Service allowing you to control Studio's Device Simulator.
|
|
15808
|
-
* @param mode
|
|
16082
|
+
* @param mode The scaling mode to apply. One of `DeviceSimulatorScalingMode.ScaleToPhysicalSize`, `DeviceSimulatorScalingMode.ActualResolution`, or `DeviceSimulatorScalingMode.FitToWindow`.
|
|
15809
16083
|
*/
|
|
15810
16084
|
SetScalingModeAsync(this: StudioDeviceSimulatorService, mode: CastsToEnum<Enum.DeviceSimulatorScalingMode>): void;
|
|
15811
16085
|
/**
|
|
16086
|
+
* Stops the active device simulation.
|
|
16087
|
+
*
|
|
15812
16088
|
* - **ThreadSafety**: Unsafe
|
|
15813
16089
|
* - **Tags**: Yields
|
|
15814
16090
|
*
|
|
@@ -15817,16 +16093,20 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
15817
16093
|
*/
|
|
15818
16094
|
StopSimulationAsync(this: StudioDeviceSimulatorService): void;
|
|
15819
16095
|
/**
|
|
16096
|
+
* Updates the configuration of an existing custom device.
|
|
16097
|
+
*
|
|
15820
16098
|
* - **ThreadSafety**: Unsafe
|
|
15821
16099
|
* - **Tags**: Yields
|
|
15822
16100
|
*
|
|
15823
16101
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#UpdateDeviceAsync)
|
|
15824
16102
|
* @param this Service allowing you to control Studio's Device Simulator.
|
|
15825
|
-
* @param deviceId
|
|
15826
|
-
* @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()`.
|
|
15827
16105
|
*/
|
|
15828
16106
|
UpdateDeviceAsync(this: StudioDeviceSimulatorService, deviceId: string, config: object): void;
|
|
15829
16107
|
/**
|
|
16108
|
+
* Fires when the active simulation state changes.
|
|
16109
|
+
*
|
|
15830
16110
|
* - **ThreadSafety**: Unsafe
|
|
15831
16111
|
*
|
|
15832
16112
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#ConfigurationChanged)
|
|
@@ -16327,6 +16607,8 @@ interface SurfaceAppearance extends Instance {
|
|
|
16327
16607
|
*/
|
|
16328
16608
|
ColorMap: ContentId;
|
|
16329
16609
|
/**
|
|
16610
|
+
* `Content` object that determines the color and opacity of the surface.
|
|
16611
|
+
*
|
|
16330
16612
|
* - **ThreadSafety**: ReadSafe
|
|
16331
16613
|
* - **Tags**: Hidden
|
|
16332
16614
|
*
|
|
@@ -16350,6 +16632,8 @@ interface SurfaceAppearance extends Instance {
|
|
|
16350
16632
|
*/
|
|
16351
16633
|
MetalnessMap: ContentId;
|
|
16352
16634
|
/**
|
|
16635
|
+
* `Content` object that determines which parts of the surface are metal or non-metal.
|
|
16636
|
+
*
|
|
16353
16637
|
* - **ThreadSafety**: ReadSafe
|
|
16354
16638
|
* - **Tags**: Hidden
|
|
16355
16639
|
*
|
|
@@ -16365,6 +16649,8 @@ interface SurfaceAppearance extends Instance {
|
|
|
16365
16649
|
*/
|
|
16366
16650
|
NormalMap: ContentId;
|
|
16367
16651
|
/**
|
|
16652
|
+
* `Content` object that modifies the lighting of the surface by adding bumps, dents, cracks, and curves.
|
|
16653
|
+
*
|
|
16368
16654
|
* - **ThreadSafety**: ReadSafe
|
|
16369
16655
|
* - **Tags**: Hidden
|
|
16370
16656
|
*
|
|
@@ -16380,6 +16666,8 @@ interface SurfaceAppearance extends Instance {
|
|
|
16380
16666
|
*/
|
|
16381
16667
|
RoughnessMap: ContentId;
|
|
16382
16668
|
/**
|
|
16669
|
+
* `Content` object that determines the apparent roughness across the surface.
|
|
16670
|
+
*
|
|
16383
16671
|
* - **ThreadSafety**: ReadSafe
|
|
16384
16672
|
* - **Tags**: Hidden
|
|
16385
16673
|
*
|
|
@@ -16984,6 +17272,8 @@ interface TextChatService extends Instance {
|
|
|
16984
17272
|
set CreateDefaultTextChannels(value: boolean);
|
|
16985
17273
|
}
|
|
16986
17274
|
/**
|
|
17275
|
+
* Represents the result of a call to `TextService:FilterStringAsync()`, used to distribute a filtered string accordingly.
|
|
17276
|
+
*
|
|
16987
17277
|
* - **Tags**: NotCreatable, NotReplicated
|
|
16988
17278
|
*
|
|
16989
17279
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextFilterResult)
|
|
@@ -16999,6 +17289,8 @@ interface TextFilterResult extends Instance {
|
|
|
16999
17289
|
readonly _nominal_TextFilterResult: unique symbol;
|
|
17000
17290
|
}
|
|
17001
17291
|
/**
|
|
17292
|
+
* Holds the filtered source text and its filtered translations produced by `TextService:FilterAndTranslateStringAsync()`.
|
|
17293
|
+
*
|
|
17002
17294
|
* - **Tags**: NotCreatable, NotReplicated
|
|
17003
17295
|
*
|
|
17004
17296
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextFilterTranslatedResult)
|
|
@@ -17546,6 +17838,8 @@ interface UIListLayout extends UIGridStyleLayout {
|
|
|
17546
17838
|
readonly _nominal_UIListLayout: unique symbol;
|
|
17547
17839
|
}
|
|
17548
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
|
+
*
|
|
17549
17843
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIPageLayout)
|
|
17550
17844
|
*/
|
|
17551
17845
|
interface UIPageLayout extends UIGridStyleLayout {
|
|
@@ -17649,6 +17943,8 @@ interface UIDragDetectorService extends Instance {
|
|
|
17649
17943
|
readonly _nominal_UIDragDetectorService: unique symbol;
|
|
17650
17944
|
}
|
|
17651
17945
|
/**
|
|
17946
|
+
* Team Create service that maps `UniqueId` to and from RFC-4122 strings; not for experience scripts.
|
|
17947
|
+
*
|
|
17652
17948
|
* - **Tags**: NotCreatable, Service
|
|
17653
17949
|
*
|
|
17654
17950
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UniqueIdLookupService)
|
|
@@ -18018,6 +18314,8 @@ interface VersionControlService extends Instance {
|
|
|
18018
18314
|
readonly _nominal_VersionControlService: unique symbol;
|
|
18019
18315
|
}
|
|
18020
18316
|
/**
|
|
18317
|
+
* Service that manages camera capture for features such as avatar facial-animation tracking. Requires `RobloxScript` security; not callable from experience scripts.
|
|
18318
|
+
*
|
|
18021
18319
|
* - **Tags**: NotCreatable, Service
|
|
18022
18320
|
*
|
|
18023
18321
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoCaptureService)
|