@rbxts/types 1.0.918 → 1.0.920
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 +347 -23
- package/include/generated/PluginSecurity.d.ts +173 -78
- package/include/generated/enums.d.ts +1800 -1323
- package/package.json +1 -1
|
@@ -140,6 +140,7 @@ interface Services {
|
|
|
140
140
|
NetworkSettings: NetworkSettings;
|
|
141
141
|
OmniRecommendationsService: OmniRecommendationsService;
|
|
142
142
|
OpenCloudService: OpenCloudService;
|
|
143
|
+
Packages: Packages;
|
|
143
144
|
PackageService: PackageService;
|
|
144
145
|
PackageUIService: PackageUIService;
|
|
145
146
|
PartyEmulatorService: PartyEmulatorService;
|
|
@@ -193,6 +194,7 @@ interface Services {
|
|
|
193
194
|
ScriptCloneWatcherHelper: ScriptCloneWatcherHelper;
|
|
194
195
|
ScriptCommitService: ScriptCommitService;
|
|
195
196
|
ScriptContext: ScriptContext;
|
|
197
|
+
ScriptDebuggerService: ScriptDebuggerService;
|
|
196
198
|
ScriptEditorService: ScriptEditorService;
|
|
197
199
|
ScriptProfilerService: ScriptProfilerService;
|
|
198
200
|
ScriptRegistrationService: ScriptRegistrationService;
|
|
@@ -1424,7 +1426,7 @@ interface Animator extends Instance {
|
|
|
1424
1426
|
*
|
|
1425
1427
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#StepAnimations)
|
|
1426
1428
|
* @param this Responsible for the playback and replication of `Animations`.
|
|
1427
|
-
* @param deltaTime The amount of time in seconds animation playback is to be incremented by.
|
|
1429
|
+
* @param deltaTime The amount of time in seconds animation playback is to be incremented. by.
|
|
1428
1430
|
*/
|
|
1429
1431
|
StepAnimations(this: Animator, deltaTime: number): void;
|
|
1430
1432
|
}
|
|
@@ -9038,6 +9040,8 @@ interface NetworkSettings extends Instance {
|
|
|
9038
9040
|
*/
|
|
9039
9041
|
readonly FreeMemoryMBytes: number;
|
|
9040
9042
|
/**
|
|
9043
|
+
* Adds jitter to playtest connections in the server-to-client direction.
|
|
9044
|
+
*
|
|
9041
9045
|
* - **ThreadSafety**: ReadSafe
|
|
9042
9046
|
* - **Tags**: NotReplicated
|
|
9043
9047
|
*
|
|
@@ -9045,6 +9049,8 @@ interface NetworkSettings extends Instance {
|
|
|
9045
9049
|
*/
|
|
9046
9050
|
InboundNetworkJitterMs: number;
|
|
9047
9051
|
/**
|
|
9052
|
+
* Sets the probability that packets on playtest connections from server to client are dropped.
|
|
9053
|
+
*
|
|
9048
9054
|
* - **ThreadSafety**: ReadSafe
|
|
9049
9055
|
* - **Tags**: NotReplicated
|
|
9050
9056
|
*
|
|
@@ -9052,6 +9058,8 @@ interface NetworkSettings extends Instance {
|
|
|
9052
9058
|
*/
|
|
9053
9059
|
InboundNetworkLossPercent: number;
|
|
9054
9060
|
/**
|
|
9061
|
+
* Adds latency to playtest connections in the server-to-client direction.
|
|
9062
|
+
*
|
|
9055
9063
|
* - **ThreadSafety**: ReadSafe
|
|
9056
9064
|
* - **Tags**: NotReplicated
|
|
9057
9065
|
*
|
|
@@ -9059,6 +9067,8 @@ interface NetworkSettings extends Instance {
|
|
|
9059
9067
|
*/
|
|
9060
9068
|
InboundNetworkMinDelayMs: number;
|
|
9061
9069
|
/**
|
|
9070
|
+
* Adds jitter to playtest connections in the client-to-server direction.
|
|
9071
|
+
*
|
|
9062
9072
|
* - **ThreadSafety**: ReadSafe
|
|
9063
9073
|
* - **Tags**: NotReplicated
|
|
9064
9074
|
*
|
|
@@ -9066,6 +9076,8 @@ interface NetworkSettings extends Instance {
|
|
|
9066
9076
|
*/
|
|
9067
9077
|
OutboundNetworkJitterMs: number;
|
|
9068
9078
|
/**
|
|
9079
|
+
* Sets the probability that packets on playtest connections from client to server are dropped.
|
|
9080
|
+
*
|
|
9069
9081
|
* - **ThreadSafety**: ReadSafe
|
|
9070
9082
|
* - **Tags**: NotReplicated
|
|
9071
9083
|
*
|
|
@@ -9073,6 +9085,8 @@ interface NetworkSettings extends Instance {
|
|
|
9073
9085
|
*/
|
|
9074
9086
|
OutboundNetworkLossPercent: number;
|
|
9075
9087
|
/**
|
|
9088
|
+
* Adds latency to playtest connections in the client-to-server direction.
|
|
9089
|
+
*
|
|
9076
9090
|
* - **ThreadSafety**: ReadSafe
|
|
9077
9091
|
* - **Tags**: NotReplicated
|
|
9078
9092
|
*
|
|
@@ -9703,6 +9717,8 @@ interface Workspace extends WorldRoot {
|
|
|
9703
9717
|
*/
|
|
9704
9718
|
readonly _nominal_Workspace: unique symbol;
|
|
9705
9719
|
/**
|
|
9720
|
+
* Controls whether parts that fall below `Workspace.FallenPartsDestroyHeight` are automatically destroyed.
|
|
9721
|
+
*
|
|
9706
9722
|
* - **ThreadSafety**: ReadSafe
|
|
9707
9723
|
*
|
|
9708
9724
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#FallHeightEnabled)
|
|
@@ -9728,6 +9744,8 @@ interface Workspace extends WorldRoot {
|
|
|
9728
9744
|
*/
|
|
9729
9745
|
set InterpolationThrottling(value: Enum.InterpolationThrottlingMode);
|
|
9730
9746
|
/**
|
|
9747
|
+
* Sets the Luau type checking mode for scripts in the experience.
|
|
9748
|
+
*
|
|
9731
9749
|
* - **ThreadSafety**: ReadSafe
|
|
9732
9750
|
*
|
|
9733
9751
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#LuauTypeCheckMode)
|
|
@@ -9843,6 +9861,21 @@ interface PackageUIService extends Instance {
|
|
|
9843
9861
|
*/
|
|
9844
9862
|
readonly _nominal_PackageUIService: unique symbol;
|
|
9845
9863
|
}
|
|
9864
|
+
/**
|
|
9865
|
+
* - **Tags**: NotCreatable, Service
|
|
9866
|
+
*
|
|
9867
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Packages)
|
|
9868
|
+
*/
|
|
9869
|
+
interface Packages extends Instance {
|
|
9870
|
+
/**
|
|
9871
|
+
* **DO NOT USE!**
|
|
9872
|
+
*
|
|
9873
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
9874
|
+
* @hidden
|
|
9875
|
+
* @deprecated
|
|
9876
|
+
*/
|
|
9877
|
+
readonly _nominal_Packages: unique symbol;
|
|
9878
|
+
}
|
|
9846
9879
|
/**
|
|
9847
9880
|
* An abstract class for pages objects.
|
|
9848
9881
|
*
|
|
@@ -10198,7 +10231,7 @@ interface PathfindingLink extends Instance {
|
|
|
10198
10231
|
readonly _nominal_PathfindingLink: unique symbol;
|
|
10199
10232
|
}
|
|
10200
10233
|
/**
|
|
10201
|
-
* Modifiers used to represent space that has a higher or lower cost to be traversed when creating paths using
|
|
10234
|
+
* Modifiers used to represent space that has a higher or lower cost to be traversed when creating paths using `PathfindingService`.
|
|
10202
10235
|
*
|
|
10203
10236
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PathfindingModifier)
|
|
10204
10237
|
*/
|
|
@@ -12409,6 +12442,93 @@ interface ScriptDebugger extends Instance {
|
|
|
12409
12442
|
*/
|
|
12410
12443
|
readonly _nominal_ScriptDebugger: unique symbol;
|
|
12411
12444
|
}
|
|
12445
|
+
/**
|
|
12446
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
12447
|
+
*
|
|
12448
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService)
|
|
12449
|
+
*/
|
|
12450
|
+
interface ScriptDebuggerService extends Instance {
|
|
12451
|
+
/**
|
|
12452
|
+
* **DO NOT USE!**
|
|
12453
|
+
*
|
|
12454
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
12455
|
+
* @hidden
|
|
12456
|
+
* @deprecated
|
|
12457
|
+
*/
|
|
12458
|
+
readonly _nominal_ScriptDebuggerService: unique symbol;
|
|
12459
|
+
/**
|
|
12460
|
+
* - **ThreadSafety**: Unsafe
|
|
12461
|
+
*
|
|
12462
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#AddBreakpoint)
|
|
12463
|
+
*/
|
|
12464
|
+
AddBreakpoint(this: ScriptDebuggerService, scriptInstance: LuaSourceContainer, breakpoint: object): object;
|
|
12465
|
+
/**
|
|
12466
|
+
* - **ThreadSafety**: Unsafe
|
|
12467
|
+
*
|
|
12468
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#ClearBreakpoints)
|
|
12469
|
+
*/
|
|
12470
|
+
ClearBreakpoints(this: ScriptDebuggerService): void;
|
|
12471
|
+
/**
|
|
12472
|
+
* - **ThreadSafety**: Unsafe
|
|
12473
|
+
*
|
|
12474
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#Evaluate)
|
|
12475
|
+
*/
|
|
12476
|
+
Evaluate(this: ScriptDebuggerService, expression: string, frameId?: number): object;
|
|
12477
|
+
/**
|
|
12478
|
+
* - **ThreadSafety**: Unsafe
|
|
12479
|
+
*
|
|
12480
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#GetRootVariables)
|
|
12481
|
+
*/
|
|
12482
|
+
GetRootVariables(this: ScriptDebuggerService, frameId: number): Array<unknown>;
|
|
12483
|
+
/**
|
|
12484
|
+
* - **ThreadSafety**: Unsafe
|
|
12485
|
+
*
|
|
12486
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#GetStackTrace)
|
|
12487
|
+
*/
|
|
12488
|
+
GetStackTrace(this: ScriptDebuggerService, threadId: number, startFrame?: number): object;
|
|
12489
|
+
/**
|
|
12490
|
+
* - **ThreadSafety**: Unsafe
|
|
12491
|
+
*
|
|
12492
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#GetThreads)
|
|
12493
|
+
*/
|
|
12494
|
+
GetThreads(this: ScriptDebuggerService): Array<unknown>;
|
|
12495
|
+
/**
|
|
12496
|
+
* - **ThreadSafety**: Unsafe
|
|
12497
|
+
*
|
|
12498
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#GetVariables)
|
|
12499
|
+
*/
|
|
12500
|
+
GetVariables(this: ScriptDebuggerService, variablesReference: number): Array<unknown>;
|
|
12501
|
+
/**
|
|
12502
|
+
* - **ThreadSafety**: Unsafe
|
|
12503
|
+
*
|
|
12504
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#Pause)
|
|
12505
|
+
*/
|
|
12506
|
+
Pause(this: ScriptDebuggerService): void;
|
|
12507
|
+
/**
|
|
12508
|
+
* - **ThreadSafety**: Unsafe
|
|
12509
|
+
*
|
|
12510
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#RemoveBreakpoint)
|
|
12511
|
+
*/
|
|
12512
|
+
RemoveBreakpoint(this: ScriptDebuggerService, scriptInstance: LuaSourceContainer, line: number): boolean;
|
|
12513
|
+
/**
|
|
12514
|
+
* - **ThreadSafety**: Unsafe
|
|
12515
|
+
*
|
|
12516
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#SetExceptionBreakMode)
|
|
12517
|
+
*/
|
|
12518
|
+
SetExceptionBreakMode(this: ScriptDebuggerService, breakMode: CastsToEnum<Enum.DebugBreakModeType>): void;
|
|
12519
|
+
/**
|
|
12520
|
+
* - **ThreadSafety**: Unsafe
|
|
12521
|
+
*
|
|
12522
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#Resumed)
|
|
12523
|
+
*/
|
|
12524
|
+
readonly Resumed: RBXScriptSignal<(threadIds: Array<unknown>) => void>;
|
|
12525
|
+
/**
|
|
12526
|
+
* - **ThreadSafety**: Unsafe
|
|
12527
|
+
*
|
|
12528
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#OnStopped)
|
|
12529
|
+
*/
|
|
12530
|
+
OnStopped: ((stopped: object) => object) | undefined;
|
|
12531
|
+
}
|
|
12412
12532
|
/**
|
|
12413
12533
|
* - **Tags**: NotCreatable, NotReplicated
|
|
12414
12534
|
*
|
|
@@ -14065,12 +14185,15 @@ interface StudioCaptureService extends Instance {
|
|
|
14065
14185
|
* - **ThreadSafety**: Unsafe
|
|
14066
14186
|
*
|
|
14067
14187
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioCaptureService#CanCaptureScreenshot)
|
|
14188
|
+
* @param this
|
|
14068
14189
|
*/
|
|
14069
14190
|
CanCaptureScreenshot(this: StudioCaptureService): boolean;
|
|
14070
14191
|
/**
|
|
14071
14192
|
* - **ThreadSafety**: Unsafe
|
|
14072
14193
|
*
|
|
14073
14194
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioCaptureService#CaptureScreenshot)
|
|
14195
|
+
* @param this
|
|
14196
|
+
* @param screenshotOptions
|
|
14074
14197
|
*/
|
|
14075
14198
|
CaptureScreenshot(this: StudioCaptureService, screenshotOptions: object): StudioScreenshotCapture;
|
|
14076
14199
|
/**
|
|
@@ -14078,6 +14201,7 @@ interface StudioCaptureService extends Instance {
|
|
|
14078
14201
|
* - **Tags**: Yields
|
|
14079
14202
|
*
|
|
14080
14203
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioCaptureService#RequestScreenshotPermissionAsync)
|
|
14204
|
+
* @param this
|
|
14081
14205
|
*/
|
|
14082
14206
|
RequestScreenshotPermissionAsync(this: StudioCaptureService): boolean;
|
|
14083
14207
|
}
|
|
@@ -14112,6 +14236,8 @@ interface StudioDeviceEmulatorService extends Instance {
|
|
|
14112
14236
|
readonly _nominal_StudioDeviceEmulatorService: unique symbol;
|
|
14113
14237
|
}
|
|
14114
14238
|
/**
|
|
14239
|
+
* Service allowing you to control Studio's Device Simulator.
|
|
14240
|
+
*
|
|
14115
14241
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
14116
14242
|
*
|
|
14117
14243
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService)
|
|
@@ -14130,6 +14256,9 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14130
14256
|
* - **Tags**: Yields
|
|
14131
14257
|
*
|
|
14132
14258
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#CreateDeviceAsync)
|
|
14259
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14260
|
+
* @param config
|
|
14261
|
+
* @returns string
|
|
14133
14262
|
*/
|
|
14134
14263
|
CreateDeviceAsync(this: StudioDeviceSimulatorService, config: object): string;
|
|
14135
14264
|
/**
|
|
@@ -14137,6 +14266,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14137
14266
|
* - **Tags**: Yields
|
|
14138
14267
|
*
|
|
14139
14268
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetDeviceAsync)
|
|
14269
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14270
|
+
* @returns string
|
|
14140
14271
|
*/
|
|
14141
14272
|
GetDeviceAsync(this: StudioDeviceSimulatorService): string;
|
|
14142
14273
|
/**
|
|
@@ -14144,6 +14275,9 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14144
14275
|
* - **Tags**: Yields
|
|
14145
14276
|
*
|
|
14146
14277
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetDeviceInfoAsync)
|
|
14278
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14279
|
+
* @param deviceId
|
|
14280
|
+
* @returns A dictionary containing the device configuration and passed to `CreateDeviceAsync` and `UpdateDeviceAsync`.
|
|
14147
14281
|
*/
|
|
14148
14282
|
GetDeviceInfoAsync(this: StudioDeviceSimulatorService, deviceId: string): object;
|
|
14149
14283
|
/**
|
|
@@ -14151,6 +14285,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14151
14285
|
* - **Tags**: Yields
|
|
14152
14286
|
*
|
|
14153
14287
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetDeviceListAsync)
|
|
14288
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14289
|
+
* @returns An array of device IDs.
|
|
14154
14290
|
*/
|
|
14155
14291
|
GetDeviceListAsync(this: StudioDeviceSimulatorService): Array<unknown>;
|
|
14156
14292
|
/**
|
|
@@ -14158,6 +14294,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14158
14294
|
* - **Tags**: Yields
|
|
14159
14295
|
*
|
|
14160
14296
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetOrientationAsync)
|
|
14297
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14298
|
+
* @returns ScreenOrientation
|
|
14161
14299
|
*/
|
|
14162
14300
|
GetOrientationAsync(this: StudioDeviceSimulatorService): Enum.ScreenOrientation;
|
|
14163
14301
|
/**
|
|
@@ -14165,6 +14303,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14165
14303
|
* - **Tags**: Yields
|
|
14166
14304
|
*
|
|
14167
14305
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetPixelDensityAsync)
|
|
14306
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14307
|
+
* @returns number
|
|
14168
14308
|
*/
|
|
14169
14309
|
GetPixelDensityAsync(this: StudioDeviceSimulatorService): number;
|
|
14170
14310
|
/**
|
|
@@ -14172,6 +14312,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14172
14312
|
* - **Tags**: Yields
|
|
14173
14313
|
*
|
|
14174
14314
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetResolutionAsync)
|
|
14315
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14316
|
+
* @returns Vector2
|
|
14175
14317
|
*/
|
|
14176
14318
|
GetResolutionAsync(this: StudioDeviceSimulatorService): Vector2;
|
|
14177
14319
|
/**
|
|
@@ -14179,6 +14321,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14179
14321
|
* - **Tags**: Yields
|
|
14180
14322
|
*
|
|
14181
14323
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetScalingModeAsync)
|
|
14324
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14325
|
+
* @returns DeviceSimulatorScalingMode
|
|
14182
14326
|
*/
|
|
14183
14327
|
GetScalingModeAsync(this: StudioDeviceSimulatorService): Enum.DeviceSimulatorScalingMode;
|
|
14184
14328
|
/**
|
|
@@ -14186,6 +14330,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14186
14330
|
* - **Tags**: Yields
|
|
14187
14331
|
*
|
|
14188
14332
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#RemoveDeviceAsync)
|
|
14333
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14334
|
+
* @param deviceId
|
|
14189
14335
|
*/
|
|
14190
14336
|
RemoveDeviceAsync(this: StudioDeviceSimulatorService, deviceId: string): void;
|
|
14191
14337
|
/**
|
|
@@ -14193,6 +14339,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14193
14339
|
* - **Tags**: Yields
|
|
14194
14340
|
*
|
|
14195
14341
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetDeviceAsync)
|
|
14342
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14343
|
+
* @param deviceId
|
|
14196
14344
|
*/
|
|
14197
14345
|
SetDeviceAsync(this: StudioDeviceSimulatorService, deviceId: string): void;
|
|
14198
14346
|
/**
|
|
@@ -14200,6 +14348,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14200
14348
|
* - **Tags**: Yields
|
|
14201
14349
|
*
|
|
14202
14350
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetOrientationAsync)
|
|
14351
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14352
|
+
* @param orientation
|
|
14203
14353
|
*/
|
|
14204
14354
|
SetOrientationAsync(this: StudioDeviceSimulatorService, orientation: CastsToEnum<Enum.ScreenOrientation>): void;
|
|
14205
14355
|
/**
|
|
@@ -14207,6 +14357,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14207
14357
|
* - **Tags**: Yields
|
|
14208
14358
|
*
|
|
14209
14359
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetPixelDensityAsync)
|
|
14360
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14361
|
+
* @param density
|
|
14210
14362
|
*/
|
|
14211
14363
|
SetPixelDensityAsync(this: StudioDeviceSimulatorService, density: number): void;
|
|
14212
14364
|
/**
|
|
@@ -14214,6 +14366,9 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14214
14366
|
* - **Tags**: Yields
|
|
14215
14367
|
*
|
|
14216
14368
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetResolutionAsync)
|
|
14369
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14370
|
+
* @param width
|
|
14371
|
+
* @param height
|
|
14217
14372
|
*/
|
|
14218
14373
|
SetResolutionAsync(this: StudioDeviceSimulatorService, width: number, height: number): void;
|
|
14219
14374
|
/**
|
|
@@ -14221,6 +14376,8 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14221
14376
|
* - **Tags**: Yields
|
|
14222
14377
|
*
|
|
14223
14378
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetScalingModeAsync)
|
|
14379
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14380
|
+
* @param mode
|
|
14224
14381
|
*/
|
|
14225
14382
|
SetScalingModeAsync(this: StudioDeviceSimulatorService, mode: CastsToEnum<Enum.DeviceSimulatorScalingMode>): void;
|
|
14226
14383
|
/**
|
|
@@ -14228,6 +14385,7 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14228
14385
|
* - **Tags**: Yields
|
|
14229
14386
|
*
|
|
14230
14387
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#StopSimulationAsync)
|
|
14388
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14231
14389
|
*/
|
|
14232
14390
|
StopSimulationAsync(this: StudioDeviceSimulatorService): void;
|
|
14233
14391
|
/**
|
|
@@ -14235,6 +14393,9 @@ interface StudioDeviceSimulatorService extends Instance {
|
|
|
14235
14393
|
* - **Tags**: Yields
|
|
14236
14394
|
*
|
|
14237
14395
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#UpdateDeviceAsync)
|
|
14396
|
+
* @param this Service allowing you to control Studio's Device Simulator.
|
|
14397
|
+
* @param deviceId
|
|
14398
|
+
* @param config
|
|
14238
14399
|
*/
|
|
14239
14400
|
UpdateDeviceAsync(this: StudioDeviceSimulatorService, deviceId: string, config: object): void;
|
|
14240
14401
|
/**
|
|
@@ -14349,12 +14510,14 @@ interface StudioScreenshotCapture extends Instance {
|
|
|
14349
14510
|
* - **ThreadSafety**: Unsafe
|
|
14350
14511
|
*
|
|
14351
14512
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioScreenshotCapture#GetBuffer)
|
|
14513
|
+
* @param this
|
|
14352
14514
|
*/
|
|
14353
14515
|
GetBuffer(this: StudioScreenshotCapture): buffer;
|
|
14354
14516
|
/**
|
|
14355
14517
|
* - **ThreadSafety**: Unsafe
|
|
14356
14518
|
*
|
|
14357
14519
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioScreenshotCapture#GetErrors)
|
|
14520
|
+
* @param this
|
|
14358
14521
|
*/
|
|
14359
14522
|
GetErrors(this: StudioScreenshotCapture): Array<unknown>;
|
|
14360
14523
|
/**
|
|
@@ -14362,6 +14525,9 @@ interface StudioScreenshotCapture extends Instance {
|
|
|
14362
14525
|
* - **Tags**: Yields
|
|
14363
14526
|
*
|
|
14364
14527
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioScreenshotCapture#ScaleAsync)
|
|
14528
|
+
* @param this
|
|
14529
|
+
* @param strategy
|
|
14530
|
+
* @param newSize
|
|
14365
14531
|
*/
|
|
14366
14532
|
ScaleAsync(this: StudioScreenshotCapture, strategy: CastsToEnum<Enum.ResamplerMode>, newSize: Vector2): StudioScreenshotCapture;
|
|
14367
14533
|
}
|
|
@@ -14520,6 +14686,9 @@ interface StudioTestService extends Instance {
|
|
|
14520
14686
|
* - **Tags**: Yields
|
|
14521
14687
|
*
|
|
14522
14688
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#ExecuteMultiplayerTestAsync)
|
|
14689
|
+
* @param this Service allowing plugins to automate and customize Test and Run mode testing.
|
|
14690
|
+
* @param numPlayers
|
|
14691
|
+
* @param args
|
|
14523
14692
|
*/
|
|
14524
14693
|
ExecuteMultiplayerTestAsync(this: StudioTestService, numPlayers: number, args: unknown): unknown;
|
|
14525
14694
|
/**
|
|
@@ -16007,6 +16176,8 @@ interface UIScale extends UIComponent {
|
|
|
16007
16176
|
readonly _nominal_UIScale: unique symbol;
|
|
16008
16177
|
}
|
|
16009
16178
|
/**
|
|
16179
|
+
* Renders a shadow below the parent UI instance.
|
|
16180
|
+
*
|
|
16010
16181
|
* - **Tags**: NotBrowsable
|
|
16011
16182
|
*
|
|
16012
16183
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow)
|
|
@@ -16114,16 +16285,6 @@ interface UserInputService extends Instance {
|
|
|
16114
16285
|
* @deprecated
|
|
16115
16286
|
*/
|
|
16116
16287
|
readonly _nominal_UserInputService: unique symbol;
|
|
16117
|
-
/**
|
|
16118
|
-
* Creates a `VirtualInput` object that a Studio plugin can use to simulate mouse, keyboard, and pointer input.
|
|
16119
|
-
*
|
|
16120
|
-
* - **ThreadSafety**: Unsafe
|
|
16121
|
-
*
|
|
16122
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#CreateVirtualInput)
|
|
16123
|
-
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
16124
|
-
* @returns A new `VirtualInput` object, or `nil` if the feature is not available.
|
|
16125
|
-
*/
|
|
16126
|
-
CreateVirtualInput(this: UserInputService): RBXObject;
|
|
16127
16288
|
}
|
|
16128
16289
|
/**
|
|
16129
16290
|
* A service that handles queries regarding users on the Roblox platform.
|
|
@@ -16912,72 +17073,6 @@ interface VirtualInput extends RBXObject {
|
|
|
16912
17073
|
* @deprecated
|
|
16913
17074
|
*/
|
|
16914
17075
|
readonly _nominal_VirtualInput: unique symbol;
|
|
16915
|
-
/**
|
|
16916
|
-
* Injects a keyboard key press or release event.
|
|
16917
|
-
*
|
|
16918
|
-
* - **ThreadSafety**: Unsafe
|
|
16919
|
-
*
|
|
16920
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendKey)
|
|
16921
|
-
* @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
16922
|
-
* @param isPressed Whether to simulate a key press (`true`) or a key release (`false`).
|
|
16923
|
-
* @param keyCode The `KeyCode` of the key to inject.
|
|
16924
|
-
* @param isRepeatedKey Whether this is an auto-repeat event, as occurs when a key is held down. Only valid for text-manipulation keys such as `KeyCode.Backspace`, `KeyCode.Delete`, and the arrow keys. Defaults to `false`.
|
|
16925
|
-
*/
|
|
16926
|
-
SendKey(this: VirtualInput, isPressed: boolean, keyCode: CastsToEnum<Enum.KeyCode>, isRepeatedKey?: boolean): void;
|
|
16927
|
-
/**
|
|
16928
|
-
* Injects a mouse button press or release event at the specified screen position.
|
|
16929
|
-
*
|
|
16930
|
-
* - **ThreadSafety**: Unsafe
|
|
16931
|
-
*
|
|
16932
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMouseButton)
|
|
16933
|
-
* @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
16934
|
-
* @param position The screen-space position in pixels at which to inject the event.
|
|
16935
|
-
* @param button The mouse button to use. Supported values are `UserInputType.MouseButton1`, `UserInputType.MouseButton2`, and `UserInputType.MouseButton3`.
|
|
16936
|
-
* @param isDown Whether to simulate a button press (`true`) or a button release (`false`).
|
|
16937
|
-
* @param repeatCount The consecutive-click count for multi-click detection, such as a double- or triple-click. Defaults to `0`.
|
|
16938
|
-
*/
|
|
16939
|
-
SendMouseButton(this: VirtualInput, position: Vector2, button: CastsToEnum<Enum.UserInputType>, isDown: boolean, repeatCount?: number): void;
|
|
16940
|
-
/**
|
|
16941
|
-
* Injects a relative mouse movement event. Only works while the player's cursor is locked.
|
|
16942
|
-
*
|
|
16943
|
-
* - **ThreadSafety**: Unsafe
|
|
16944
|
-
*
|
|
16945
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMouseDelta)
|
|
16946
|
-
* @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
16947
|
-
* @param positionDelta The relative mouse movement in pixels along each axis.
|
|
16948
|
-
*/
|
|
16949
|
-
SendMouseDelta(this: VirtualInput, positionDelta: Vector2): void;
|
|
16950
|
-
/**
|
|
16951
|
-
* Moves the virtual mouse cursor to the specified absolute screen position.
|
|
16952
|
-
*
|
|
16953
|
-
* - **ThreadSafety**: Unsafe
|
|
16954
|
-
*
|
|
16955
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMousePosition)
|
|
16956
|
-
* @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
16957
|
-
* @param position The target screen-space position in pixels.
|
|
16958
|
-
*/
|
|
16959
|
-
SendMousePosition(this: VirtualInput, position: Vector2): void;
|
|
16960
|
-
/**
|
|
16961
|
-
* Injects a scroll wheel, trackpad pan, or pinch gesture event at the specified screen position.
|
|
16962
|
-
*
|
|
16963
|
-
* - **ThreadSafety**: Unsafe
|
|
16964
|
-
*
|
|
16965
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendPointerAction)
|
|
16966
|
-
* @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
16967
|
-
* @param position The screen-space position in pixels at which to inject the event.
|
|
16968
|
-
* @param pointerAction A dictionary describing the pointer action to inject. Accepted keys are `Wheel` (number), `Pan` (`Vector2`), and `Pinch` (number). At least one key must have a non-zero value.
|
|
16969
|
-
*/
|
|
16970
|
-
SendPointerAction(this: VirtualInput, position: Vector2, pointerAction: object): void;
|
|
16971
|
-
/**
|
|
16972
|
-
* Injects a text input event as if the specified string was typed on a keyboard.
|
|
16973
|
-
*
|
|
16974
|
-
* - **ThreadSafety**: Unsafe
|
|
16975
|
-
*
|
|
16976
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendTextInput)
|
|
16977
|
-
* @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
16978
|
-
* @param text The string to inject as text input.
|
|
16979
|
-
*/
|
|
16980
|
-
SendTextInput(this: VirtualInput, text: string): void;
|
|
16981
17076
|
}
|
|
16982
17077
|
/**
|
|
16983
17078
|
* - **Tags**: NotCreatable, NotReplicated
|