@rbxts/types 1.0.822 → 1.0.824
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 +245 -1
- package/include/roblox.d.ts +13 -0
- package/package.json +1 -1
|
@@ -177,6 +177,7 @@ interface Services {
|
|
|
177
177
|
TeleportService: TeleportService;
|
|
178
178
|
TemporaryCageMeshProvider: TemporaryCageMeshProvider;
|
|
179
179
|
TemporaryScriptService: TemporaryScriptService;
|
|
180
|
+
TestService: TestService;
|
|
180
181
|
TextBoxService: TextBoxService;
|
|
181
182
|
TextChatService: TextChatService;
|
|
182
183
|
TextService: TextService;
|
|
@@ -11514,7 +11515,7 @@ interface ContextActionService extends Instance {
|
|
|
11514
11515
|
* @param this A service used to bind user input to contextual actions.
|
|
11515
11516
|
* @param actionName
|
|
11516
11517
|
*/
|
|
11517
|
-
GetBoundActionInfo(this: ContextActionService, actionName: string): BoundActionInfo;
|
|
11518
|
+
GetBoundActionInfo(this: ContextActionService, actionName: string): BoundActionInfo | {};
|
|
11518
11519
|
/**
|
|
11519
11520
|
* Return the `BackpackItem.TextureId` of a `Tool` currently `equipped` by the `Player`.
|
|
11520
11521
|
*
|
|
@@ -35187,6 +35188,249 @@ interface TerrainRegion extends Instance {
|
|
|
35187
35188
|
*/
|
|
35188
35189
|
readonly SizeInCells: Vector3;
|
|
35189
35190
|
}
|
|
35191
|
+
/**
|
|
35192
|
+
* A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
35193
|
+
*
|
|
35194
|
+
* - **Tags**: Service
|
|
35195
|
+
*
|
|
35196
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService)
|
|
35197
|
+
*/
|
|
35198
|
+
interface TestService extends Instance {
|
|
35199
|
+
/**
|
|
35200
|
+
* **DO NOT USE!**
|
|
35201
|
+
*
|
|
35202
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
35203
|
+
* @hidden
|
|
35204
|
+
* @deprecated
|
|
35205
|
+
*/
|
|
35206
|
+
readonly _nominal_TestService: unique symbol;
|
|
35207
|
+
/**
|
|
35208
|
+
* If set to true, the game will start running when the TestService's `TestService:Run()` method is called.
|
|
35209
|
+
*
|
|
35210
|
+
* - **ThreadSafety**: ReadSafe
|
|
35211
|
+
*
|
|
35212
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#AutoRuns)
|
|
35213
|
+
*/
|
|
35214
|
+
AutoRuns: boolean;
|
|
35215
|
+
/**
|
|
35216
|
+
* A description of the test being executed.
|
|
35217
|
+
*
|
|
35218
|
+
* - **ThreadSafety**: ReadSafe
|
|
35219
|
+
*
|
|
35220
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Description)
|
|
35221
|
+
*/
|
|
35222
|
+
Description: string;
|
|
35223
|
+
/**
|
|
35224
|
+
* Measures how many errors have been recorded in the test session.
|
|
35225
|
+
*
|
|
35226
|
+
* - **ThreadSafety**: ReadSafe
|
|
35227
|
+
* - **Tags**: NotReplicated
|
|
35228
|
+
*
|
|
35229
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#ErrorCount)
|
|
35230
|
+
*/
|
|
35231
|
+
readonly ErrorCount: number;
|
|
35232
|
+
/**
|
|
35233
|
+
* When set to true, the TestService will be executed when using the *Run* action in Roblox Studio.
|
|
35234
|
+
*
|
|
35235
|
+
* - **ThreadSafety**: ReadSafe
|
|
35236
|
+
*
|
|
35237
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#ExecuteWithStudioRun)
|
|
35238
|
+
*/
|
|
35239
|
+
ExecuteWithStudioRun: boolean;
|
|
35240
|
+
/**
|
|
35241
|
+
* Sets whether or not the physics engine should be throttled to 30 FPS while the test is being ran.
|
|
35242
|
+
*
|
|
35243
|
+
* - **ThreadSafety**: ReadSafe
|
|
35244
|
+
*
|
|
35245
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Is30FpsThrottleEnabled)
|
|
35246
|
+
*/
|
|
35247
|
+
Is30FpsThrottleEnabled: boolean;
|
|
35248
|
+
/**
|
|
35249
|
+
* Sets whether or not the physics environment should be throttled while running this test.
|
|
35250
|
+
*
|
|
35251
|
+
* - **ThreadSafety**: ReadSafe
|
|
35252
|
+
*
|
|
35253
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#IsPhysicsEnvironmentalThrottled)
|
|
35254
|
+
*/
|
|
35255
|
+
IsPhysicsEnvironmentalThrottled: boolean;
|
|
35256
|
+
/**
|
|
35257
|
+
* Sets whether or not physics objects will be allowed to fall asleep while the test simulation is running.
|
|
35258
|
+
*
|
|
35259
|
+
* - **ThreadSafety**: ReadSafe
|
|
35260
|
+
*
|
|
35261
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#IsSleepAllowed)
|
|
35262
|
+
*/
|
|
35263
|
+
IsSleepAllowed: boolean;
|
|
35264
|
+
/**
|
|
35265
|
+
* The number of players expected in this test, if any.
|
|
35266
|
+
*
|
|
35267
|
+
* - **ThreadSafety**: ReadSafe
|
|
35268
|
+
*
|
|
35269
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#NumberOfPlayers)
|
|
35270
|
+
*/
|
|
35271
|
+
NumberOfPlayers: number;
|
|
35272
|
+
/**
|
|
35273
|
+
* Sets a specific amount of additional latency experienced by players during the test session.
|
|
35274
|
+
*
|
|
35275
|
+
* - **ThreadSafety**: ReadSafe
|
|
35276
|
+
*
|
|
35277
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#SimulateSecondsLag)
|
|
35278
|
+
*/
|
|
35279
|
+
SimulateSecondsLag: number;
|
|
35280
|
+
/**
|
|
35281
|
+
* Measures how many test calls have been recorded in the test session.
|
|
35282
|
+
*
|
|
35283
|
+
* - **ThreadSafety**: ReadSafe
|
|
35284
|
+
* - **Tags**: NotReplicated
|
|
35285
|
+
*
|
|
35286
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#TestCount)
|
|
35287
|
+
*/
|
|
35288
|
+
readonly TestCount: number;
|
|
35289
|
+
/**
|
|
35290
|
+
* The maximum amount of time that tests are allowed to run for.
|
|
35291
|
+
*
|
|
35292
|
+
* - **ThreadSafety**: ReadSafe
|
|
35293
|
+
*
|
|
35294
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Timeout)
|
|
35295
|
+
*/
|
|
35296
|
+
Timeout: number;
|
|
35297
|
+
/**
|
|
35298
|
+
* Measures how many warning calls have been recorded in the test session.
|
|
35299
|
+
*
|
|
35300
|
+
* - **ThreadSafety**: ReadSafe
|
|
35301
|
+
* - **Tags**: NotReplicated
|
|
35302
|
+
*
|
|
35303
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#WarnCount)
|
|
35304
|
+
*/
|
|
35305
|
+
readonly WarnCount: number;
|
|
35306
|
+
/**
|
|
35307
|
+
* Prints result of condition to output.
|
|
35308
|
+
*
|
|
35309
|
+
* - **ThreadSafety**: Unsafe
|
|
35310
|
+
*
|
|
35311
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Check)
|
|
35312
|
+
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
35313
|
+
* @param condition
|
|
35314
|
+
* @param description
|
|
35315
|
+
* @param source
|
|
35316
|
+
* @param line
|
|
35317
|
+
*/
|
|
35318
|
+
Check(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
|
|
35319
|
+
/**
|
|
35320
|
+
* Prints "Test checkpoint: ", followed by text, to the output, in blue text.
|
|
35321
|
+
*
|
|
35322
|
+
* - **ThreadSafety**: Unsafe
|
|
35323
|
+
*
|
|
35324
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Checkpoint)
|
|
35325
|
+
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
35326
|
+
* @param text
|
|
35327
|
+
* @param source
|
|
35328
|
+
* @param line
|
|
35329
|
+
*/
|
|
35330
|
+
Checkpoint(this: TestService, text: string, source?: Instance, line?: number): void;
|
|
35331
|
+
/**
|
|
35332
|
+
* Prints Testing Done to the output, in blue text.
|
|
35333
|
+
*
|
|
35334
|
+
* - **ThreadSafety**: Unsafe
|
|
35335
|
+
*
|
|
35336
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Done)
|
|
35337
|
+
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
35338
|
+
*/
|
|
35339
|
+
Done(this: TestService): void;
|
|
35340
|
+
/**
|
|
35341
|
+
* Prints a red message to the output, prefixed by `TestService:`.
|
|
35342
|
+
*
|
|
35343
|
+
* - **ThreadSafety**: Unsafe
|
|
35344
|
+
*
|
|
35345
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Error)
|
|
35346
|
+
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
35347
|
+
* @param description
|
|
35348
|
+
* @param source
|
|
35349
|
+
* @param line
|
|
35350
|
+
*/
|
|
35351
|
+
Error(this: TestService, description: string, source?: Instance, line?: number): void;
|
|
35352
|
+
/**
|
|
35353
|
+
* Indicates a fatal error in a TestService run. If this is called inside of a script running inside of the TestService, this will initiate a breakpoint on the line that invoked the error.
|
|
35354
|
+
*
|
|
35355
|
+
* - **ThreadSafety**: Unsafe
|
|
35356
|
+
*
|
|
35357
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Fail)
|
|
35358
|
+
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
35359
|
+
* @param description
|
|
35360
|
+
* @param source
|
|
35361
|
+
* @param line
|
|
35362
|
+
*/
|
|
35363
|
+
Fail(this: TestService, description: string, source?: Instance, line?: number): void;
|
|
35364
|
+
/**
|
|
35365
|
+
* Prints Test message, followed by text to the output, in blue text.
|
|
35366
|
+
*
|
|
35367
|
+
* - **ThreadSafety**: Unsafe
|
|
35368
|
+
*
|
|
35369
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Message)
|
|
35370
|
+
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
35371
|
+
* @param text
|
|
35372
|
+
* @param source
|
|
35373
|
+
* @param line
|
|
35374
|
+
*/
|
|
35375
|
+
Message(this: TestService, text: string, source?: Instance, line?: number): void;
|
|
35376
|
+
/**
|
|
35377
|
+
* Prints whether a condition is true along with description text.
|
|
35378
|
+
*
|
|
35379
|
+
* - **ThreadSafety**: Unsafe
|
|
35380
|
+
*
|
|
35381
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Require)
|
|
35382
|
+
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
35383
|
+
* @param condition
|
|
35384
|
+
* @param description
|
|
35385
|
+
* @param source
|
|
35386
|
+
* @param line
|
|
35387
|
+
*/
|
|
35388
|
+
Require(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
|
|
35389
|
+
/**
|
|
35390
|
+
* - **ThreadSafety**: Unsafe
|
|
35391
|
+
*
|
|
35392
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#ScopeTime)
|
|
35393
|
+
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
35394
|
+
*/
|
|
35395
|
+
ScopeTime(this: TestService): object;
|
|
35396
|
+
/**
|
|
35397
|
+
* Prints if a condition is true, otherwise prints a warning.
|
|
35398
|
+
*
|
|
35399
|
+
* - **ThreadSafety**: Unsafe
|
|
35400
|
+
*
|
|
35401
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Warn)
|
|
35402
|
+
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
35403
|
+
* @param condition
|
|
35404
|
+
* @param description
|
|
35405
|
+
* @param source
|
|
35406
|
+
* @param line
|
|
35407
|
+
*/
|
|
35408
|
+
Warn(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
|
|
35409
|
+
/**
|
|
35410
|
+
* - **ThreadSafety**: Unsafe
|
|
35411
|
+
*
|
|
35412
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#isFeatureEnabled)
|
|
35413
|
+
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
35414
|
+
* @param name
|
|
35415
|
+
*/
|
|
35416
|
+
isFeatureEnabled(this: TestService, name: string): boolean;
|
|
35417
|
+
/**
|
|
35418
|
+
* Fired when the server should collect a conditional test result.
|
|
35419
|
+
*
|
|
35420
|
+
* - **ThreadSafety**: Unsafe
|
|
35421
|
+
*
|
|
35422
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#ServerCollectConditionalResult)
|
|
35423
|
+
*/
|
|
35424
|
+
readonly ServerCollectConditionalResult: RBXScriptSignal<(condition: boolean, text: string, script: Instance, line: number) => void>;
|
|
35425
|
+
/**
|
|
35426
|
+
* Fired when the server should collect a test result.
|
|
35427
|
+
*
|
|
35428
|
+
* - **ThreadSafety**: Unsafe
|
|
35429
|
+
*
|
|
35430
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#ServerCollectResult)
|
|
35431
|
+
*/
|
|
35432
|
+
readonly ServerCollectResult: RBXScriptSignal<(text: string, script: Instance, line: number) => void>;
|
|
35433
|
+
}
|
|
35190
35434
|
/**
|
|
35191
35435
|
* - **Tags**: NotCreatable, Service
|
|
35192
35436
|
*
|
package/include/roblox.d.ts
CHANGED
|
@@ -296,8 +296,21 @@ interface PlayerJoinInfo {
|
|
|
296
296
|
}
|
|
297
297
|
|
|
298
298
|
interface BoundActionInfo {
|
|
299
|
+
/** Describes whether a touch button should be created on TouchEnabled devices */
|
|
300
|
+
createTouchButton: boolean;
|
|
301
|
+
/** The description of action set by SetDescription */
|
|
302
|
+
description?: string;
|
|
303
|
+
/** The title of the action set by SetTitle */
|
|
304
|
+
title?: string;
|
|
305
|
+
/** The image of the action's touch button set by SetImage */
|
|
306
|
+
image?: string;
|
|
307
|
+
/** The input types passed to BindAction for which this action will trigger */
|
|
299
308
|
inputTypes: Array<Enum.KeyCode | Enum.PlayerActions | Enum.UserInputType | string>;
|
|
309
|
+
/** Describes the priority level of the action.
|
|
310
|
+
* Priority level will still be included even if `BindActionAtPriority` wasn't used - by default it will be 2000.
|
|
311
|
+
*/
|
|
300
312
|
priorityLevel: number;
|
|
313
|
+
/** Describes the index of the action on the stack (increasing) */
|
|
301
314
|
stackOrder: number;
|
|
302
315
|
}
|
|
303
316
|
|